Compare commits
11
Commits
db0d81e78e
...
next
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
c316d9ee78 | ||
|
|
b9bb1569fd | ||
|
|
4be625dc06 | ||
|
|
e2965469ba | ||
|
|
2691702f80 | ||
|
|
5f2b606754 | ||
|
|
f53b503b15 | ||
|
|
45aead6340 | ||
|
|
e517219038 | ||
|
|
a3da448f0d | ||
|
|
93c34e1a2a |
@@ -461,13 +461,15 @@ address, the transaction assertions run against the raw signed transaction
|
|||||||
captured at `eth_sendRawTransaction` rather than against anything the extension
|
captured at `eth_sendRawTransaction` rather than against anything the extension
|
||||||
reported, rejecting each prompt is required to return a rejection to the page
|
reported, rejecting each prompt is required to return a rejection to the page
|
||||||
rather than hang or resolve, a network switch request is required to leave the
|
rather than hang or resolve, a network switch request is required to leave the
|
||||||
stored network unchanged and send no `chainChanged` until it is approved, a
|
stored network unchanged and send no `chainChanged` until it is approved, the
|
||||||
network switch in Settings is required to send the page `chainChanged` with the
|
popup open all along is required to show the `[TESTNET]` banner once a switch to
|
||||||
new chain id, a prompt raised while another approval window has focus is
|
Sepolia is approved and to drop it once the switch back is, a network switch in
|
||||||
required to open a window of its own, and the password is required to be absent
|
Settings is required to send the page `chainChanged` with the new chain id, a
|
||||||
from every message the approval window sends to the background — with the
|
prompt raised while another approval window has focus is required to open a
|
||||||
message that would carry it required to be present, so that check cannot pass by
|
window of its own, and the password is required to be absent from every message
|
||||||
observing nothing. That last one is the standing floor under
|
the approval window sends to the background — with the message that would carry
|
||||||
|
it required to be present, so that check cannot pass by observing nothing. That
|
||||||
|
last one is the standing floor under
|
||||||
[#157](https://git.eeqj.de/sneak/AutistMask/issues/157).
|
[#157](https://git.eeqj.de/sneak/AutistMask/issues/157).
|
||||||
|
|
||||||
The limits of that coverage and of the rest of the Chrome suite, none of them
|
The limits of that coverage and of the rest of the Chrome suite, none of them
|
||||||
@@ -603,9 +605,10 @@ suite), wallet creation through the UI, the Add Token screen, and the dApp round
|
|||||||
trips — `eth_requestAccounts`, `personal_sign`, `wallet_switchEthereumChain`
|
trips — `eth_requestAccounts`, `personal_sign`, `wallet_switchEthereumChain`
|
||||||
rejected and then approved, `eth_sendTransaction`, and a closed approval window
|
rejected and then approved, `eth_sendTransaction`, and a closed approval window
|
||||||
rejecting with EIP-1193 4001 — driven through the real content script,
|
rejecting with EIP-1193 4001 — driven through the real content script,
|
||||||
background page and approval windows. The `personal_sign` prompt is also
|
background page and approval windows. The popup open all along is required to
|
||||||
required to fit its window without scrolling sideways, with the extension's
|
show the `[TESTNET]` banner once the switch to Sepolia is approved and to drop
|
||||||
pages at 170% zoom.
|
it once the switch back is. The `personal_sign` prompt is also required to fit
|
||||||
|
its window without scrolling sideways, with the extension's pages at 170% zoom.
|
||||||
|
|
||||||
The suite lives in `tests/e2e/firefox/`. Its WebDriver client (`driver.js`) has
|
The suite lives in `tests/e2e/firefox/`. Its WebDriver client (`driver.js`) has
|
||||||
**no npm dependencies at all**: it is built on global `fetch` and
|
**no npm dependencies at all**: it is built on global `fetch` and
|
||||||
@@ -842,7 +845,7 @@ src/
|
|||||||
views/ — one JS module per screen (home, send, approval, etc.)
|
views/ — one JS module per screen (home, send, approval, etc.)
|
||||||
shared/ — modules used by both popup and background
|
shared/ — modules used by both popup and background
|
||||||
alarms.js — recurring background jobs (extension alarms API)
|
alarms.js — recurring background jobs (extension alarms API)
|
||||||
balances.js — ETH + ERC-20 balance fetching via RPC + Blockscout
|
balances.js — ETH and tracked token balances via RPC, others via Blockscout
|
||||||
constants.js — chain IDs, default RPC endpoint, ERC-20 ABI
|
constants.js — chain IDs, default RPC endpoint, ERC-20 ABI
|
||||||
ens.js — ENS forward/reverse resolution (popup only)
|
ens.js — ENS forward/reverse resolution (popup only)
|
||||||
holders.js — holder-count parsing and the low-holder rule
|
holders.js — holder-count parsing and the low-holder rule
|
||||||
@@ -1129,13 +1132,15 @@ scale is not an approximation but a different number — 1,000 units of a
|
|||||||
6-decimal token formatted at 18 decimals reads `0.000000001` — on the screen
|
6-decimal token formatted at 18 decimals reads `0.000000001` — on the screen
|
||||||
whose only job is to state what is being authorized. Both amount paths of that
|
whose only job is to state what is being authorized. Both amount paths of that
|
||||||
screen take this rule: the ERC-20 `transfer`/`approve` line
|
screen take this rule: the ERC-20 `transfer`/`approve` line
|
||||||
(`src/popup/views/approval.js`) and the swap's `Amount` and `Min. received`
|
(`src/popup/views/approval.js`) and the swap's `Amount`, `Min. received`,
|
||||||
lines (`src/shared/uniswap.js`). The token permission warning on the signature
|
`Moved from the sender` and `Permit2 allowance` lines and the `Paid to` line of
|
||||||
screen takes the same rule for its amounts. An unbounded allowance or permit
|
a move into the router (`src/shared/uniswap.js`). The token permission warning
|
||||||
needs no scale to describe and is still shown as `Unlimited`. A source's answer
|
on the signature screen takes the same rule for its amounts. An unbounded
|
||||||
counts only if it is a whole number from 0 to 80: `decimals()` returns a
|
allowance or permit needs no scale to describe and is still shown as
|
||||||
`uint8`, but `formatUnits()` cannot format more than 80 decimal places, so a
|
`Unlimited`. A source's answer counts only if it is a whole number from 0 to 80:
|
||||||
token that reports 81 to 255 is shown as one whose scale nothing knows.
|
`decimals()` returns a `uint8`, but `formatUnits()` cannot format more than 80
|
||||||
|
decimal places, so a token that reports 81 to 255 is shown as one whose scale
|
||||||
|
nothing knows.
|
||||||
|
|
||||||
The rule holds only if nothing invents a scale UPSTREAM of it. Those three
|
The rule holds only if nothing invents a scale UPSTREAM of it. Those three
|
||||||
sources are read as authoritative, so a value written into one of them cannot be
|
sources are read as authoritative, so a value written into one of them cannot be
|
||||||
@@ -1168,8 +1173,8 @@ fetched, without that cross-address check, and shows the row's figure.
|
|||||||
**Decoded amount lines on the transaction approval screen:** the `Amount` line
|
**Decoded amount lines on the transaction approval screen:** the `Amount` line
|
||||||
of a decoded ERC-20 call, and the `Amount` and `Min. received` lines of a
|
of a decoded ERC-20 call, and the `Amount` and `Min. received` lines of a
|
||||||
decoded swap (see TxApproval below; `Min. received` reads `Min. paid out` unless
|
decoded swap (see TxApproval below; `Min. received` reads `Min. paid out` unless
|
||||||
only the user is paid, see Transaction Decoding), do not always read as a
|
only the user is paid and no allowance goes to a spender other than the router,
|
||||||
number. They can read:
|
see Transaction Decoding), do not always read as a number. They can read:
|
||||||
|
|
||||||
- A formatted quantity, e.g. `17.1900 USDT`, when the token's scale is known:
|
- A formatted quantity, e.g. `17.1900 USDT`, when the token's scale is known:
|
||||||
truncated to four decimals, with the floor and the zero cases described above.
|
truncated to four decimals, with the floor and the zero cases described above.
|
||||||
@@ -1238,7 +1243,11 @@ only when no earlier step set it. It finds each side by three rules:
|
|||||||
is their sum; in any other case the step gives no `Amount`. The decoder reads
|
is their sum; in any other case the step gives no `Amount`. The decoder reads
|
||||||
no amount from an exact-out action, and an open delta is not a stated amount.
|
no amount from an exact-out action, and an open delta is not a stated amount.
|
||||||
Its `Min. received` is found the same way, from the `amountOutMin` of the
|
Its `Min. received` is found the same way, from the `amountOutMin` of the
|
||||||
actions that buy the output currency.
|
actions that buy the output currency, except that the step gives none when a
|
||||||
|
swap action in it also spends the output currency, because the step then does
|
||||||
|
not pay out all that those actions buy. A step that buys at least 0.5 WETH
|
||||||
|
with USDT and swaps 0.3 WETH of it for USDC, with WETH as its output side,
|
||||||
|
gives no `Min. received`.
|
||||||
3. If any swap action in the step could not be read, only `SETTLE`,
|
3. If any swap action in the step could not be read, only `SETTLE`,
|
||||||
`SETTLE_ALL`, `TAKE` and `TAKE_ALL` name its sides, and the step gives no
|
`SETTLE_ALL`, `TAKE` and `TAKE_ALL` name its sides, and the step gives no
|
||||||
`Amount` or `Min. received`. A side they did not name is unknown, and the
|
`Amount` or `Min. received`. A side they did not name is unknown, and the
|
||||||
@@ -1260,17 +1269,29 @@ runs (Transaction Decoding below gives what the router holds). The router
|
|||||||
unwraps only the WETH it holds, so WETH that step paid to the user, or to anyone
|
unwraps only the WETH it holds, so WETH that step paid to the user, or to anyone
|
||||||
else, stays WETH: a swap that pays the router WETH, then a swap that pays the
|
else, stays WETH: a swap that pays the router WETH, then a swap that pays the
|
||||||
user WETH, then an unwrap, shows WETH with the second swap's minimum. The
|
user WETH, then an unwrap, shows WETH with the second swap's minimum. The
|
||||||
minimum reads in ETH when that step paid all its WETH to the router. When it
|
minimum reads in ETH only when that step paid all its WETH to the router and
|
||||||
paid only part of it to the router, as a V4 step does that `TAKE`s some of its
|
every step between it and the `UNWRAP_WETH` is one the decoder read of these: a
|
||||||
WETH to the user and the rest to the router, or paid the router WETH beside a
|
`PERMIT2_PERMIT`, a `BALANCE_CHECK_ERC20`, or a `SWEEP`, `TRANSFER`,
|
||||||
payout the decoder cannot read, the swap shows ETH with no minimum: the decoder
|
`PAY_PORTION` or `PAY_PORTION_FULL_PRECISION` of a token other than WETH, but
|
||||||
does not count how much of that step's minimum reaches the router, nor read the
|
not of ETH to a WETH contract, which pays the router WETH. None of these can
|
||||||
`UNWRAP_WETH`'s own minimum. A later step that sets the output side sets it
|
take WETH out of the router or pay anyone WETH; the decoder treats every other
|
||||||
anew. Otherwise `Token Out` and `Min. received` keep the output side's own token
|
step as one that may. Otherwise the swap shows ETH with no minimum, as it does
|
||||||
and figure, whether the swap was paid in ETH or in a token: a V2 exact-out swap
|
after a V4 step that `TAKE`s some of its WETH to the user and the rest to the
|
||||||
that buys USDC and then unwraps the WETH it did not spend shows USDC. The token
|
router, or that pays the router WETH beside a payout the decoder cannot read,
|
||||||
permission warning on the signature screen has its own amount wording, including
|
and with a WETH interface fee paid by `PAY_PORTION` before the `UNWRAP_WETH`:
|
||||||
`Unknown`; the SignApproval section below describes it.
|
the decoder does not count how much of that step's minimum reaches the
|
||||||
|
`UNWRAP_WETH`, nor read the `UNWRAP_WETH`'s own minimum. When an `UNWRAP_WETH`
|
||||||
|
of that WETH pays the router, or its recipient cannot be read, the router may
|
||||||
|
hold the ETH, and a later step may pay it out as WETH, as a `WRAP_ETH` of it to
|
||||||
|
the user does: after any later step but those listed, the swap shows WETH with
|
||||||
|
no minimum. Once the swap shows no minimum, or shows WETH this way, no later
|
||||||
|
step, a later `UNWRAP_WETH` included, brings back the minimum or ETH; only a
|
||||||
|
later step that sets the output side sets it anew. Otherwise `Token Out` and
|
||||||
|
`Min. received` keep the output side's own token and figure, whether the swap
|
||||||
|
was paid in ETH or in a token: a V2 exact-out swap that buys USDC and then
|
||||||
|
unwraps the WETH it did not spend shows USDC. The token permission warning on
|
||||||
|
the signature screen has its own amount wording, including `Unknown`; the
|
||||||
|
SignApproval section below describes it.
|
||||||
|
|
||||||
The swap's `Deadline` line is the router's deadline as a UTC date and time, e.g.
|
The swap's `Deadline` line is the router's deadline as a UTC date and time, e.g.
|
||||||
`2026-02-27 08:25:51`. A JavaScript date reaches only to 275760-09-13 00:00:00
|
`2026-02-27 08:25:51`. A JavaScript date reaches only to 275760-09-13 00:00:00
|
||||||
@@ -1358,23 +1379,30 @@ The core hierarchy is **Wallets → Addresses**:
|
|||||||
- The user can have multiple wallets, each with multiple addresses (HD) or a
|
- The user can have multiple wallets, each with multiple addresses (HD) or a
|
||||||
single address (key).
|
single address (key).
|
||||||
|
|
||||||
Which tokens an address shows is decided by `fetchTokenBalances()` in
|
Which tokens an address shows is decided on every refresh by `refreshBalances()`
|
||||||
`src/shared/balances.js`, from the Blockscout `token-balances` response, so
|
in `src/shared/balances.js`. The balance of each token tracked on the active
|
||||||
tokens do appear without the user adding them. An ERC-20 is shown when its
|
network is read with `balanceOf` through the RPC endpoint, for every address.
|
||||||
balance is nonzero and it is in the bundled known-token list, is tracked by the
|
Its holder count and `decimals` are those of Blockscout's entry for it in the
|
||||||
user, or has 1,000 or more holders; a token claiming a symbol from the bundled
|
same refresh, kept from before while Blockscout fails. A read that fails keeps
|
||||||
list from any other contract address is always dropped, and so is any token
|
that token's previous entry, as a failed ETH balance keeps its figure, or takes
|
||||||
claiming a symbol that belongs to the native asset and therefore has no
|
Blockscout's entry from the same refresh when there is none. Every other token
|
||||||
legitimate contract at all (`"ETH"`, and every network's `nativeCurrency`, such
|
comes from the Blockscout `token-balances` response (`fetchTokenBalances()`), so
|
||||||
as `"SepoliaETH"`, on every network). That filter is unconditional — the "Hide
|
tokens do appear without the user adding them, and they keep their previous
|
||||||
tokens with fewer than 1,000 holders" setting governs the transaction history
|
figures while Blockscout fails. A tracked token is shown when its balance is
|
||||||
and the send-screen token selector, not this list. A token's holder count is
|
nonzero, and any other ERC-20 when its balance is nonzero and it is in the
|
||||||
unknown when the explorer reports none, or reports anything other than a whole
|
bundled known-token list or has 1,000 or more holders. A token claiming a symbol
|
||||||
number written in digits alone, such as `1,000` or `1e3` (`parseHoldersCount()`
|
from the bundled list from any other contract address is always dropped, tracked
|
||||||
in `src/shared/holders.js`). This list does not take an unknown count as 1,000
|
or not, and so is any token claiming a symbol that belongs to the native asset
|
||||||
or more, so such a token is shown only when it is on the bundled list or
|
and therefore has no legitimate contract at all (`"ETH"`, and every network's
|
||||||
tracked. `fetchTokenBalances()` stores every nonzero holding of a token it
|
`nativeCurrency`, such as `"SepoliaETH"`, on every network). That filter is
|
||||||
admits, however small, but a holding below 0.000001 is left out of the balance
|
unconditional — the "Hide tokens with fewer than 1,000 holders" setting governs
|
||||||
|
the transaction history and the send-screen token selector, not this list. A
|
||||||
|
token's holder count is unknown when the explorer reports none, or reports
|
||||||
|
anything other than a whole number written in digits alone, such as `1,000` or
|
||||||
|
`1e3` (`parseHoldersCount()` in `src/shared/holders.js`). This list does not
|
||||||
|
take an unknown count as 1,000 or more, so such a token is shown only when it is
|
||||||
|
on the bundled list or tracked. Every nonzero holding of a token shown is stored
|
||||||
|
exactly, however small, but a holding below 0.000001 is left out of the balance
|
||||||
lists, the send-screen token selector, the address total and the remove-address
|
lists, the send-screen token selector, the address total and the remove-address
|
||||||
warning (`isBelowOneMillionth()` in `src/shared/amountDisplay.js`). The Send and
|
warning (`isBelowOneMillionth()` in `src/shared/amountDisplay.js`). The Send and
|
||||||
confirmation screens show it when its token is the one being sent. Tracked
|
confirmation screens show it when its token is the one being sent. Tracked
|
||||||
@@ -1389,6 +1417,19 @@ carries a `schemaVersion` — `STATE_SCHEMA_VERSION` in
|
|||||||
`saveState()` and the background's `updateState()` both do, so whichever context
|
`saveState()` and the background's `updateState()` both do, so whichever context
|
||||||
wrote last, the record says which build's shape it is in.
|
wrote last, the record says which build's shape it is in.
|
||||||
|
|
||||||
|
Each write reads the record, changes it and writes it back, holding a lock from
|
||||||
|
the read to the write: the browser's own (`navigator.locks`), taken through
|
||||||
|
`withLock()` in `src/shared/browserApi.js`. Every page of the extension and its
|
||||||
|
background share it, except a page in a Firefox private window, which Firefox
|
||||||
|
gives locks of its own (see https://git.eeqj.de/sneak/AutistMask/issues/646).
|
||||||
|
The popup's `saveState()`, the background's `updateState()` and the
|
||||||
|
StateRecovery reset all take it, so among the pages and the background that
|
||||||
|
share it, no write lands between another write's read and its write, where it
|
||||||
|
would be lost. Chrome has it from version 69, older than any Chrome that runs a
|
||||||
|
Manifest V3 extension, in pages and in the service worker; Firefox from version
|
||||||
|
96, older than the 115 `manifest/firefox.json` declares. Where it is missing, a
|
||||||
|
write fails rather than going ahead without it.
|
||||||
|
|
||||||
Version 1 is the shape that shipped before versions existed, so a stored record
|
Version 1 is the shape that shipped before versions existed, so a stored record
|
||||||
with no `schemaVersion` is version 1 rather than a defect: it loads normally and
|
with no `schemaVersion` is version 1 rather than a defect: it loads normally and
|
||||||
is migrated in place by being stamped on the first write. An upgrade never shows
|
is migrated in place by being stamped on the first write. An upgrade never shows
|
||||||
@@ -1537,20 +1578,29 @@ such as an edit typed into Settings and not yet saved. Home is the one screen
|
|||||||
"Back" always re-renders, so the wallet list reflects anything that changed
|
"Back" always re-renders, so the wallet list reflects anything that changed
|
||||||
while the user was away from it.
|
while the user was away from it.
|
||||||
|
|
||||||
A network switch in Settings leaves every screen beneath Settings showing the
|
A network switch leaves every screen on the page showing the previous network.
|
||||||
previous network, so after it "Back" behaves as in a reopened popup: every
|
The user makes it in Settings, or approves a site's request and the background
|
||||||
screen on the stack counts as not yet rendered, and the stack is cut at the
|
saves it. Any other popup open meanwhile takes the switch from the stored
|
||||||
first screen that cannot be rendered from saved state, such as Send or AddToken,
|
record, even one saved while it was opening, and never switches the network
|
||||||
or at AddressToken for any token but the native one, because that token was
|
itself. A switch the user picks in its Settings while it takes one is made after
|
||||||
picked on the previous network. The cut stack is saved with the switch, so a
|
it, not overwritten by it. An approval window does not take the switch. After
|
||||||
popup closed straight after it and reopened onto Settings lands in the same
|
the switch, whichever way the page got it, "Back" behaves as in a reopened
|
||||||
place. "Back" then renders the screen it lands on for the new network, and
|
popup: every screen on the stack counts as not yet rendered, and the stack is
|
||||||
anything typed there and not saved, which belonged to the previous network, is
|
cut at the first screen that cannot be rendered from saved state, such as Send
|
||||||
dropped. ConfirmTx, WaitTx, SuccessTx, ErrorTx and TransactionDetail are
|
or AddToken, or at AddressToken for any token but the native one, because that
|
||||||
rendered instead for the network of the transaction they show: the network it
|
token was picked on the previous network and is no longer selected. The cut
|
||||||
was reviewed on for ConfirmTx, and the network it was sent on for the others.
|
stack is saved with the popup's new network, so a popup closed straight after
|
||||||
Without a wallet the stack is not cut, because it starts at Welcome, which shows
|
and reopened lands in the same place. The screen on top is drawn again for the
|
||||||
nothing from a network.
|
new network: Settings in place, and any other screen as a reopened popup draws
|
||||||
|
it, so Home takes the place of one that cannot be rendered from saved state or
|
||||||
|
of AddressToken for a token no longer selected. "Back" then renders the screen
|
||||||
|
it lands on for the new network, and anything typed there and not saved, which
|
||||||
|
belonged to the previous network, is dropped. ConfirmTx, WaitTx, SuccessTx,
|
||||||
|
ErrorTx and TransactionDetail are rendered instead for the network of the
|
||||||
|
transaction they show: the network it was reviewed on for ConfirmTx, and the
|
||||||
|
network it was sent on for the others. Without a wallet the stack is not cut and
|
||||||
|
only Settings is drawn again, because the stack starts at Welcome, and Welcome
|
||||||
|
and AddWallet show nothing from a network.
|
||||||
|
|
||||||
Every screen that holds secret material in the page registers a cleanup with
|
Every screen that holds secret material in the page registers a cleanup with
|
||||||
`onViewLeave()` (`src/popup/views/helpers.js`), which `showView()` runs on every
|
`onViewLeave()` (`src/popup/views/helpers.js`), which `showView()` runs on every
|
||||||
@@ -2067,8 +2117,11 @@ view would leave a wallet one click from deletion.
|
|||||||
none, and the tokens tracked on that network, and sends `chainChanged`
|
none, and the tokens tracked on that network, and sends `chainChanged`
|
||||||
with the new chain id to every open tab. A token is tracked only on the
|
with the new chain id to every open tab. A token is tracked only on the
|
||||||
network it was added on, because a contract address names a token on one
|
network it was added on, because a contract address names a token on one
|
||||||
network only. Choosing the network already active changes nothing and
|
network only. Switching also clears every address's balances. A balance
|
||||||
sends nothing
|
refresh, by the popup or the background, stores what it fetched only if
|
||||||
|
the stored network is still the one it fetched on when it returns, so the
|
||||||
|
previous network's balances never reach the new one. Choosing the network
|
||||||
|
already active changes nothing and sends nothing
|
||||||
- Ethereum RPC: endpoint URL input + "Save" button (validated against
|
- Ethereum RPC: endpoint URL input + "Save" button (validated against
|
||||||
`eth_chainId` before being saved)
|
`eth_chainId` before being saved)
|
||||||
- Blockscout API: endpoint URL input + "Save" button (validated against
|
- Blockscout API: endpoint URL input + "Save" button (validated against
|
||||||
@@ -2397,10 +2450,12 @@ view would leave a wallet one click from deletion.
|
|||||||
transaction"
|
transaction"
|
||||||
- Decoded action (if calldata is recognized): action name, token details,
|
- Decoded action (if calldata is recognized): action name, token details,
|
||||||
amounts, what each swap step spends that the `Amount` line does not give,
|
amounts, what each swap step spends that the `Amount` line does not give,
|
||||||
what each `PERMIT2_TRANSFER_FROM` moves and where to, steps, deadline, and
|
what each `PERMIT2_TRANSFER_FROM` moves and where to, what each
|
||||||
unless a swap pays only the From address, a `Paid to` line for each other
|
`PERMIT2_PERMIT` whose amount is not the `Amount` figure, and each
|
||||||
address it pays, or saying that a token stays in the router or who it pays
|
`PERMIT2_PERMIT_BATCH`, lets its spender take, steps, deadline, and unless
|
||||||
is unknown (see Transaction Decoding)
|
a swap pays only the From address, a `Paid to` line for each other address
|
||||||
|
it pays, or saying that a token stays in the router or who it pays is
|
||||||
|
unknown (see Transaction Decoding)
|
||||||
- From: color dot + full address + etherscan link
|
- From: color dot + full address + etherscan link
|
||||||
- Contract: color dot + full address + etherscan link, token symbol label if
|
- Contract: color dot + full address + etherscan link, token symbol label if
|
||||||
known; for a contract creation, the same sentence as on WaitTx
|
known; for a contract creation, the same sentence as on WaitTx
|
||||||
@@ -2614,7 +2669,8 @@ AutistMask is not a fully self-contained offline tool. It necessarily
|
|||||||
communicates with three external services to function as a wallet:
|
communicates with three external services to function as a wallet:
|
||||||
|
|
||||||
- **Ethereum JSON-RPC endpoint**: The extension needs an Ethereum node to query
|
- **Ethereum JSON-RPC endpoint**: The extension needs an Ethereum node to query
|
||||||
balances (`eth_getBalance`), read ERC-20 token contracts (`eth_call`),
|
balances (`eth_getBalance`), read ERC-20 token contracts (`eth_call`), among
|
||||||
|
them the balance of every tracked token at every address (`balanceOf`),
|
||||||
estimate gas (`eth_estimateGas`), fetch nonces (`eth_getTransactionCount`),
|
estimate gas (`eth_estimateGas`), fetch nonces (`eth_getTransactionCount`),
|
||||||
broadcast transactions (`eth_sendRawTransaction`), and check transaction
|
broadcast transactions (`eth_sendRawTransaction`), and check transaction
|
||||||
receipts. The default endpoint is a public RPC (configurable by the user to
|
receipts. The default endpoint is a public RPC (configurable by the user to
|
||||||
@@ -3153,8 +3209,9 @@ Currently supported:
|
|||||||
`Min. paid out`, because the swap's minimum includes the fee. The minimum
|
`Min. paid out`, because the swap's minimum includes the fee. The minimum
|
||||||
reads `Min. received` only when some step pays the transaction's sender (the
|
reads `Min. received` only when some step pays the transaction's sender (the
|
||||||
From address on TxApproval, the sender the explorer reports on
|
From address on TxApproval, the sender the explorer reports on
|
||||||
TransactionDetail) and no `Paid to` line is shown. `Paid to` lines after
|
TransactionDetail), no `Paid to` line is shown, and no permit or batch grants
|
||||||
`Token Out` name each other address paid; one reads
|
an allowance to a spender other than the router (see below). `Paid to` lines
|
||||||
|
after `Token Out` name each other address paid; one reads
|
||||||
`The bridge, which pays the deposit's recipient on another network` for a
|
`The bridge, which pays the deposit's recipient on another network` for a
|
||||||
bridge deposit; one reads, for example,
|
bridge deposit; one reads, for example,
|
||||||
`The router, 2000.0000 USDT from the sender (later steps may not spend all of it)`
|
`The router, 2000.0000 USDT from the sender (later steps may not spend all of it)`
|
||||||
@@ -3189,38 +3246,57 @@ Currently supported:
|
|||||||
added to the total while both are quantities: a V3 exact-in of 600 USDT and a
|
added to the total while both are quantities: a V3 exact-in of 600 USDT and a
|
||||||
V2 exact-in of 400 USDT, both paid by the user, read `1000.0000 USDT`. When
|
V2 exact-in of 400 USDT, both paid by the user, read `1000.0000 USDT`. When
|
||||||
the decoder does not know a take's amount, the total is not known and there is
|
the decoder does not know a take's amount, the total is not known and there is
|
||||||
no `Amount` line. `Token In` is the token of the last `PERMIT2_PERMIT` the
|
no `Amount` line. A `PERMIT2_PERMIT` names `Token In` only when its amount,
|
||||||
decoder reads, when there is one. Its amount, `Unlimited` included, stands as
|
`Unlimited` included, stands as the `Amount` figure in place of the total,
|
||||||
the `Amount` figure in place of the total only in the plain shape of Uniswap's
|
which it does only in the plain shape of Uniswap's own routes: it comes before
|
||||||
own routes: it is the only `PERMIT2_PERMIT`, its spender is the router, the
|
the step that sets the input side, it is the only `PERMIT2_PERMIT` in the
|
||||||
router may not let it fail, no step before it takes its token or a token the
|
transaction and there is no `PERMIT2_PERMIT_BATCH`, its spender is the router,
|
||||||
decoder does not know, and the decoder reads every step after it in full.
|
the router may not let it fail, no step before it takes its token, a
|
||||||
Permit2 then lets the router take no more of the token than that amount, so
|
`PERMIT2_TRANSFER_FROM` of it included, or a token the decoder does not know,
|
||||||
the permit covers every take of it. A step the decoder does not read in full
|
and the decoder reads every step after it in full. Permit2 then lets the
|
||||||
may raise what Permit2 lets the router take, as a `PERMIT2_PERMIT_BATCH` can:
|
router take no more of the token than that amount, so the permit covers every
|
||||||
a command the decoder does not read (listed at the end of this section), a
|
take of it. A step before the permit takes under whatever allowance the router
|
||||||
step whose input it cannot read, in whole or in part, and a step it fails on.
|
already had, so it may take more than the permit's amount, which would then
|
||||||
In any other case the line gives the total, as with no permit. When the step
|
read lower than what leaves the user's wallet: a `PERMIT2_TRANSFER_FROM` of
|
||||||
that sets the input side spends a token other than the permit's, or one the
|
2,000 USDT into the router, then a permit of 600 USDT to the router and a V3
|
||||||
decoder does not know, its amount gets lines of its own, unless it states no
|
exact-in of 2,000 USDT paid from the router, read `Amount 2000.0000 USDT`. A
|
||||||
amount and the user pays it none of its input token, and the total has no
|
later permit or batch may raise what Permit2 lets the router take, and so may
|
||||||
figure to start from: unless the permit's amount stands there is no `Amount`
|
a step the decoder does not read in full: a command the decoder does not read
|
||||||
line, and each take of the permit's token gets lines of its own. Each take the
|
(listed at the end of this section), a step whose input it cannot read, in
|
||||||
total does not count gives three lines after the `Amount` line (after
|
whole or in part, and a step it fails on. Every other `PERMIT2_PERMIT`, before
|
||||||
`Token In` when there is none): one of a token other than `Token In`; one of
|
the step that sets the input side or after it, leaves `Token In` and the
|
||||||
`Token In` after an amount that is not a quantity (a V4 open delta,
|
`Amount` line as they read with no permit, unless it lets a spender other than
|
||||||
`ALREADY_PAID`, which keep their wording on the `Amount` line, or no stated
|
the router take `Token In` (see below): a permit of 5,000 DAI to another
|
||||||
amount, as of a V4 exact-out step); and one whose amount the decoder does not
|
address and then a V3 exact-in of 600 USDT read `Swap USDT → USDC` with
|
||||||
know. When the step that sets the input side states no amount, the user pays
|
`Amount 600.0000 USDT`, and so do that exact-in and then a permit of 5,000 DAI
|
||||||
it some of its input token, and there is no `Amount` line, that step gets them
|
to the router. When a permit's amount stands and the step that sets the input
|
||||||
too whenever another take's lines give a figure, or a `PERMIT2_TRANSFER_FROM`
|
side spends a token other than the permit's, or one the decoder does not know,
|
||||||
of its token gives one, on the lines below or, into the router, on its
|
that step's amount gets lines of its own, unless it states no amount and the
|
||||||
`Paid to` line, so that figure cannot read as all that leaves. When it states
|
user pays it none of its input token. Each take the total does not count gives
|
||||||
no amount and the user pays it none of its input token, as when the router
|
three lines after the `Amount` line (after `Token In` when there is none): one
|
||||||
pays it, that step takes none of that token from the user's wallet and never
|
of a token other than `Token In`; one of `Token In` after an amount that is
|
||||||
gets them, with a permit or without. They come in step order, the step that
|
not a quantity (a V4 open delta, `ALREADY_PAID`, which keep their wording on
|
||||||
sets the input side first when it has them: `Moved from the sender`, its
|
the `Amount` line, or no stated amount, as of a V4 exact-out step); and one
|
||||||
amount, worded as the `Amount` line words one, or
|
whose amount the decoder does not know. When there is no `Amount` line, each
|
||||||
|
take the total counts gets them too, so that every amount the decoder reads is
|
||||||
|
shown: the amount the step that sets the input side states, when it is a
|
||||||
|
quantity and the user pays that step (a V2 or V3 step whose `payerIsUser` is
|
||||||
|
true, a V4 step the user pays some of its input token, or a `WRAP_ETH`, whose
|
||||||
|
ETH comes from the transaction's value), and each later take of `Token In`
|
||||||
|
added to it. A step that sets the input side and is paid from the router takes
|
||||||
|
nothing from the user's wallet and gets none. A `PERMIT2_PERMIT` the decoder
|
||||||
|
cannot read, then V3 exact-ins of 600 USDT and 400 DAI paid by the user, give
|
||||||
|
lines for both amounts. When the step that sets the input side states no
|
||||||
|
amount, the user pays it some of its input token, and there is no `Amount`
|
||||||
|
line, that step gets them too whenever another take's lines give a figure, or
|
||||||
|
a `PERMIT2_TRANSFER_FROM` of its token gives one, on the lines below or, into
|
||||||
|
the router, on its `Paid to` line, so that figure cannot read as all that
|
||||||
|
leaves. When it states no amount and the user pays it none of its input token,
|
||||||
|
as when the router pays it, that step takes none of that token from the user's
|
||||||
|
wallet and never gets them, with a permit or without. They come in step order,
|
||||||
|
except that the step that sets the input side comes first when it has them,
|
||||||
|
followed, when there is no `Amount` line, by the other takes the total counts:
|
||||||
|
`Moved from the sender`, its amount, worded as the `Amount` line words one, or
|
||||||
`Unknown (could not be decoded)` when the decoder does not know it;
|
`Unknown (could not be decoded)` when the decoder does not know it;
|
||||||
`Token moved`, giving the token's address as the `Token In` line does; and
|
`Token moved`, giving the token's address as the `Token In` line does; and
|
||||||
`Moved to`, which reads `The swap step that spends it`. A token the decoder
|
`Moved to`, which reads `The swap step that spends it`. A token the decoder
|
||||||
@@ -3243,11 +3319,34 @@ Currently supported:
|
|||||||
on every router but `UniversalRouterV1`, and otherwise gives the address. A
|
on every router but `UniversalRouterV1`, and otherwise gives the address. A
|
||||||
move into the router needs none of them, because its `Paid to` line and
|
move into the router needs none of them, because its `Paid to` line and
|
||||||
`Token moved into the router` line already give the amount, the token and
|
`Token moved into the router` line already give the amount, the token and
|
||||||
where it goes, and so its amount is shown once. These lines change neither the
|
where it goes, and so its amount is shown once. Every `PERMIT2_PERMIT` whose
|
||||||
`Paid to` lines nor the minimum's label. A step goes unread when its recipient
|
amount does not stand as the `Amount` figure, before the step that sets the
|
||||||
does not decode as an address, when it is a V3 swap step whose path is shorter
|
input side or after it, gives three lines, in step order, after those for each
|
||||||
than one token address or has bytes after its last hop, or when it is a
|
`PERMIT2_TRANSFER_FROM`: `Permit2 allowance`, its amount, for example
|
||||||
command the decoder does not read: every command other than `PERMIT2_PERMIT`,
|
`5000.0000 DAI`, or `Unlimited` for Permit2's maximum; `Allowance token`,
|
||||||
|
giving the token's address as the `Token In` line does; and
|
||||||
|
`Allowance spender`, the address it lets take the token. Only a permit whose
|
||||||
|
amount stands gives none: the `Amount` line gives its amount, `Token In` its
|
||||||
|
token, and its spender is the router. Each allowance a `PERMIT2_PERMIT_BATCH`
|
||||||
|
grants, one for each token it names, all for its one spender, gives the same
|
||||||
|
three lines, in step order with those of each `PERMIT2_PERMIT`. A
|
||||||
|
`PERMIT2_PERMIT` or `PERMIT2_PERMIT_BATCH` whose input the decoder cannot
|
||||||
|
read, such as one whose token or spender word has a nonzero top byte, may let
|
||||||
|
any spender take any amount of any token: it gives one `Permit2 allowance`
|
||||||
|
line alone, reading `Unknown (could not be decoded)`. These lines change no
|
||||||
|
`Paid to` line: a permit or batch pays nobody. But code that a step runs, such
|
||||||
|
as a V4 pool's hook or a token's own code, can call a spender other than the
|
||||||
|
router, which can then take up to its allowance from the user's wallet before
|
||||||
|
the transaction ends. So an allowance to any spender but the router, or a
|
||||||
|
permit or batch the decoder cannot read, makes the minimum read
|
||||||
|
`Min. paid out`, and when its token is `Token In`, or the decoder does not
|
||||||
|
know its token or `Token In`, it leaves no `Amount` line, whose figure might
|
||||||
|
be too low: a permit of 5,000 USDT to another address and then a V3 exact-in
|
||||||
|
of 600 USDT read with no `Amount` line, and the 600 USDT gets lines of its
|
||||||
|
own. A step goes unread when its recipient does not decode as an address, when
|
||||||
|
it is a V3 swap step whose path is shorter than one token address or has bytes
|
||||||
|
after its last hop, or when it is a command the decoder does not read: every
|
||||||
|
command other than `PERMIT2_PERMIT`, `PERMIT2_PERMIT_BATCH`,
|
||||||
`PERMIT2_TRANSFER_FROM`, `V2_SWAP_EXACT_IN`, `V2_SWAP_EXACT_OUT`,
|
`PERMIT2_TRANSFER_FROM`, `V2_SWAP_EXACT_IN`, `V2_SWAP_EXACT_OUT`,
|
||||||
`V3_SWAP_EXACT_IN`, `V3_SWAP_EXACT_OUT`, `V4_SWAP`, `SWEEP`, `TRANSFER`,
|
`V3_SWAP_EXACT_IN`, `V3_SWAP_EXACT_OUT`, `V4_SWAP`, `SWEEP`, `TRANSFER`,
|
||||||
`PAY_PORTION`, `PAY_PORTION_FULL_PRECISION`, `ACROSS_V4_DEPOSIT_V3`,
|
`PAY_PORTION`, `PAY_PORTION_FULL_PRECISION`, `ACROSS_V4_DEPOSIT_V3`,
|
||||||
|
|||||||
@@ -13,6 +13,11 @@
|
|||||||
"fmt": "prettier --write .",
|
"fmt": "prettier --write .",
|
||||||
"fmt-check": "prettier --check ."
|
"fmt-check": "prettier --check ."
|
||||||
},
|
},
|
||||||
|
"jest": {
|
||||||
|
"setupFiles": [
|
||||||
|
"<rootDir>/tests/support/navigatorLocks.js"
|
||||||
|
]
|
||||||
|
},
|
||||||
"devDependencies": {
|
"devDependencies": {
|
||||||
"@eslint/js": "10.0.1",
|
"@eslint/js": "10.0.1",
|
||||||
"@tailwindcss/cli": "4.3.1",
|
"@tailwindcss/cli": "4.3.1",
|
||||||
|
|||||||
@@ -1379,6 +1379,13 @@ const RECENT_BALANCE_REFRESH_MS = Math.floor(BALANCE_REFRESH_PERIOD_MS / 2);
|
|||||||
// balances that came back — by address, onto whatever storage holds NOW.
|
// balances that came back — by address, onto whatever storage holds NOW.
|
||||||
// Applying by address rather than writing the array back is what keeps a
|
// Applying by address rather than writing the array back is what keeps a
|
||||||
// wallet or address added, renamed or deleted during the round trip.
|
// wallet or address added, renamed or deleted during the round trip.
|
||||||
|
//
|
||||||
|
// Nothing is applied when the network stored NOW is not the one the refresh
|
||||||
|
// ran on. A network switch during the round trip cleared every address's
|
||||||
|
// balances (applyChainSwitchFields()), and the previous network's must not come
|
||||||
|
// back over them (https://git.eeqj.de/sneak/AutistMask/issues/577).
|
||||||
|
// lastBalanceRefresh is left as the switch set it, so the next tick refreshes
|
||||||
|
// the new network.
|
||||||
async function backgroundRefresh() {
|
async function backgroundRefresh() {
|
||||||
const s = await getState();
|
const s = await getState();
|
||||||
const now = Date.now();
|
const now = Date.now();
|
||||||
@@ -1402,6 +1409,7 @@ async function backgroundRefresh() {
|
|||||||
}
|
}
|
||||||
|
|
||||||
await updateState((fresh) => {
|
await updateState((fresh) => {
|
||||||
|
if (fresh.networkId !== s.networkId) return;
|
||||||
for (const wallet of fresh.wallets) {
|
for (const wallet of fresh.wallets) {
|
||||||
for (const addr of wallet.addresses || []) {
|
for (const addr of wallet.addresses || []) {
|
||||||
const got = refreshed.get(String(addr.address).toLowerCase());
|
const got = refreshed.get(String(addr.address).toLowerCase());
|
||||||
|
|||||||
+19
-26
@@ -16,17 +16,20 @@
|
|||||||
// across any number of awaits and no concurrent work can
|
// across any number of awaits and no concurrent work can
|
||||||
// move it.
|
// move it.
|
||||||
// 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 inside a queue, so two background writes
|
// back — all holding the lock every write of the stored
|
||||||
// never interleave, and the read is one storage round trip
|
// record takes, so no other write lands in between, by
|
||||||
// ahead of the write rather than a page lifetime ahead of
|
// the background or by any page except a page in a
|
||||||
// it (which is what made the popup's saveState() need a
|
// Firefox private window (README, "Stored state and its
|
||||||
|
// version"). The read is one storage round trip ahead of
|
||||||
|
// the write rather than a page lifetime ahead of it
|
||||||
|
// (which is what made the popup's saveState() need a
|
||||||
// per-field merge against a baseline at all).
|
// 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
|
||||||
// against a snapshot it owns, and applies the RESULT inside updateState().
|
// against a snapshot it owns, and applies the RESULT inside updateState().
|
||||||
// It never publishes an object other in-flight work is holding.
|
// It never publishes an object other in-flight work is holding.
|
||||||
|
|
||||||
const { storageGet, storageSet } = require("../shared/browserApi");
|
const { storageGet, storageSet, withLock } = require("../shared/browserApi");
|
||||||
const { normalizePersisted } = require("../shared/persistedState");
|
const { normalizePersisted } = require("../shared/persistedState");
|
||||||
const {
|
const {
|
||||||
STATE_SCHEMA_VERSION,
|
STATE_SCHEMA_VERSION,
|
||||||
@@ -51,11 +54,6 @@ async function getState() {
|
|||||||
return normalizePersisted(result.autistmask);
|
return normalizePersisted(result.autistmask);
|
||||||
}
|
}
|
||||||
|
|
||||||
// Serializes the read-modify-write turns below. Two of them interleaved would
|
|
||||||
// each read before the other wrote, and the second write would carry the first
|
|
||||||
// one's fields back to their pre-turn values.
|
|
||||||
let updateQueue = Promise.resolve();
|
|
||||||
|
|
||||||
async function updateStateOnce(mutate) {
|
async function updateStateOnce(mutate) {
|
||||||
const s = await getState();
|
const s = await getState();
|
||||||
await mutate(s);
|
await mutate(s);
|
||||||
@@ -70,27 +68,22 @@ async function updateStateOnce(mutate) {
|
|||||||
|
|
||||||
// Apply `mutate` to a record read fresh from storage and write the result
|
// Apply `mutate` to a record read fresh from storage and write the result
|
||||||
// back. `mutate` receives a detached, normalized profile and mutates it in
|
// back. `mutate` receives a detached, normalized profile and mutates it in
|
||||||
// place; it may be async, but it must not do anything slow — the window
|
// place; it may be async, but it must not do anything slow. The write is the
|
||||||
// between the read and the write is the window in which another context's
|
// WHOLE record, which is safe only because the lock (withLock() in
|
||||||
// write is lost, and keeping it to one storage round trip is what makes a
|
// src/shared/browserApi.js) is held from the read to the write: two
|
||||||
// whole-record write safe here. Concretely: the write is the WHOLE record, so
|
// background turns, or a turn and a page's save, never interleave
|
||||||
// a popup write that lands inside that window is reverted, in every field, by
|
// (https://git.eeqj.de/sneak/AutistMask/issues/641). Every page's save waits
|
||||||
// the record this turn read before it. That is accepted because the window is
|
// while it is held, except a page in a Firefox private window, which Firefox
|
||||||
// one round trip long and the popup is not writing while the worker is;
|
// gives locks of its own (README, "Stored state and its version").
|
||||||
// widening it is what would make it a real hazard.
|
|
||||||
//
|
//
|
||||||
// `mutate` must also not call updateState() itself, directly or through
|
// `mutate` must also not call updateState() itself, directly or through
|
||||||
// anything it awaits: the queue is strictly serial, so the inner turn waits on
|
// anything it awaits: the inner turn waits for the lock the outer one holds,
|
||||||
// the outer one, which is waiting on the inner one. That deadlocks the whole
|
// and the outer one is waiting on the inner one. That deadlocks every write of
|
||||||
// background, not just the caller. Mutate the record you were handed.
|
// the stored record, not just the caller. Mutate the record you were handed.
|
||||||
//
|
//
|
||||||
// Resolves with the record that was written.
|
// Resolves with the record that was written.
|
||||||
function updateState(mutate) {
|
function updateState(mutate) {
|
||||||
const turn = updateQueue.then(() => updateStateOnce(mutate));
|
return withLock("autistmask", () => updateStateOnce(mutate));
|
||||||
// The queue must advance even when a turn rejects, or every update after
|
|
||||||
// it queues behind a promise that never settles.
|
|
||||||
updateQueue = turn.catch(() => {});
|
|
||||||
return turn;
|
|
||||||
}
|
}
|
||||||
|
|
||||||
module.exports = { getState, updateState };
|
module.exports = { getState, updateState };
|
||||||
|
|||||||
+74
-5
@@ -5,12 +5,14 @@ const {
|
|||||||
state,
|
state,
|
||||||
saveState,
|
saveState,
|
||||||
onSaveFailure,
|
onSaveFailure,
|
||||||
|
takeStoredNetwork,
|
||||||
loadState,
|
loadState,
|
||||||
} = require("../shared/state");
|
} = require("../shared/state");
|
||||||
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 } = require("../shared/balances");
|
||||||
|
const { clearPopupCaches } = require("../shared/chainSwitch");
|
||||||
const {
|
const {
|
||||||
$,
|
$,
|
||||||
showView,
|
showView,
|
||||||
@@ -22,6 +24,7 @@ const {
|
|||||||
} = require("./views/helpers");
|
} = require("./views/helpers");
|
||||||
const { applyTheme } = require("./theme");
|
const { applyTheme } = require("./theme");
|
||||||
const {
|
const {
|
||||||
|
onStorageChanged,
|
||||||
tabsGetCurrent,
|
tabsGetCurrent,
|
||||||
tabsGetZoom,
|
tabsGetZoom,
|
||||||
windowsGetCurrent,
|
windowsGetCurrent,
|
||||||
@@ -68,23 +71,55 @@ 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 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
|
||||||
|
// 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,
|
||||||
|
// reaches this page only after the stored record (followNetworkSwitch() below).
|
||||||
|
// A switch while the refresh ran cleared every address's balances
|
||||||
|
// (applyChainSwitchFields() in src/shared/chainSwitchFields.js), and the
|
||||||
|
// previous network's must not come back over them
|
||||||
|
// (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
|
||||||
|
// removed meanwhile is left as it is.
|
||||||
async function doRefreshAndRender() {
|
async function doRefreshAndRender() {
|
||||||
if (refreshInFlight) return;
|
if (refreshInFlight) return;
|
||||||
refreshInFlight = true;
|
refreshInFlight = true;
|
||||||
try {
|
try {
|
||||||
|
const networkId = state.networkId;
|
||||||
|
const wallets = structuredClone(state.wallets);
|
||||||
await Promise.all([
|
await Promise.all([
|
||||||
refreshPrices(),
|
refreshPrices(),
|
||||||
refreshBalances(
|
refreshBalances(
|
||||||
state.wallets,
|
wallets,
|
||||||
state.rpcUrl,
|
state.rpcUrl,
|
||||||
state.blockscoutUrl,
|
state.blockscoutUrl,
|
||||||
state.trackedTokens,
|
state.trackedTokens,
|
||||||
state.networkId,
|
networkId,
|
||||||
pageClosed.signal,
|
pageClosed.signal,
|
||||||
),
|
),
|
||||||
]);
|
]);
|
||||||
state.lastBalanceRefresh = Date.now();
|
const refreshed = new Map();
|
||||||
await saveState();
|
for (const wallet of wallets) {
|
||||||
|
for (const addr of wallet.addresses) {
|
||||||
|
refreshed.set(addr.address, addr);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
await saveState((stored) => {
|
||||||
|
if (state.networkId !== networkId) return false;
|
||||||
|
if (stored.networkId !== networkId) return false;
|
||||||
|
for (const wallet of state.wallets) {
|
||||||
|
for (const addr of wallet.addresses) {
|
||||||
|
const got = refreshed.get(addr.address);
|
||||||
|
if (!got) continue;
|
||||||
|
for (const key of ["balance", "ensName", "tokenBalances"]) {
|
||||||
|
if (got[key] !== undefined) addr[key] = got[key];
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
state.lastBalanceRefresh = Date.now();
|
||||||
|
return true;
|
||||||
|
});
|
||||||
renderWalletList();
|
renderWalletList();
|
||||||
} catch (e) {
|
} catch (e) {
|
||||||
// Every call site fires this and walks away — the boot below, the ten
|
// Every call site fires this and walks away — the boot below, the ten
|
||||||
@@ -116,6 +151,7 @@ const ctx = {
|
|||||||
renderWalletList,
|
renderWalletList,
|
||||||
doRefreshAndRender,
|
doRefreshAndRender,
|
||||||
startRefresh,
|
startRefresh,
|
||||||
|
restoreView,
|
||||||
pageClosed: pageClosed.signal,
|
pageClosed: pageClosed.signal,
|
||||||
showAddWalletView: () => {
|
showAddWalletView: () => {
|
||||||
pushCurrentView();
|
pushCurrentView();
|
||||||
@@ -183,6 +219,28 @@ function fallbackView() {
|
|||||||
showView("main");
|
showView("main");
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// When the background saves a network switch, once the user approves a site's
|
||||||
|
// request, or another popup page saves one, this page follows the stored
|
||||||
|
// record. It takes the network the record names as a save reads it, holding
|
||||||
|
// the lock, so no later save of this page writes the previous network back, and
|
||||||
|
// then leaves the page as a switch in Settings leaves it. This page's own
|
||||||
|
// switch in Settings is made under the lock as well (onChainSwitch() in
|
||||||
|
// 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
|
||||||
|
// here while this waits for the lock is made after it.
|
||||||
|
async function followNetworkSwitch() {
|
||||||
|
let switched = false;
|
||||||
|
// A failed save is reported by saveState() itself: see onSaveFailure().
|
||||||
|
await saveState((stored) => {
|
||||||
|
if (stored.networkId === state.networkId) return false;
|
||||||
|
settings.cutViewStack();
|
||||||
|
takeStoredNetwork(stored);
|
||||||
|
clearPopupCaches();
|
||||||
|
switched = true;
|
||||||
|
}).catch(() => {});
|
||||||
|
if (switched) settings.showNewNetwork();
|
||||||
|
}
|
||||||
|
|
||||||
// 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
|
||||||
// browser counts the window's frame in that width, and a screen taller than
|
// browser counts the window's frame in that width, and a screen taller than
|
||||||
// the window takes a vertical scrollbar out of it too. So once the screen is
|
// the window takes a vertical scrollbar out of it too. So once the screen is
|
||||||
@@ -220,7 +278,7 @@ async function widenApprovalWindow() {
|
|||||||
async function init() {
|
async function init() {
|
||||||
// First, before anything can save: showView() saves on every navigation
|
// First, before anything can save: showView() saves on every navigation
|
||||||
// without awaiting, so a save that fails from here on has somewhere to be
|
// without awaiting, so a save that fails from here on has somewhere to be
|
||||||
// reported rather than being swallowed by the save queue
|
// reported rather than reaching only the console
|
||||||
// (https://git.eeqj.de/sneak/AutistMask/issues/362). Registered ahead of
|
// (https://git.eeqj.de/sneak/AutistMask/issues/362). Registered ahead of
|
||||||
// the approval-window branch below too, since that window saves as well.
|
// the approval-window branch below too, since that window saves as well.
|
||||||
//
|
//
|
||||||
@@ -327,6 +385,17 @@ 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
|
||||||
|
// one this page's own switch in Settings saves names the network it
|
||||||
|
// already has, and a record naming none is no switch.
|
||||||
|
onStorageChanged((changes) => {
|
||||||
|
const written = changes.autistmask && changes.autistmask.newValue;
|
||||||
|
if (!written || !written.networkId) return;
|
||||||
|
if (written.networkId !== state.networkId) followNetworkSwitch();
|
||||||
|
});
|
||||||
|
// A switch saved since loadState() above, before there was a listener.
|
||||||
|
followNetworkSwitch();
|
||||||
|
|
||||||
if (!state.hasWallet) {
|
if (!state.hasWallet) {
|
||||||
showView("welcome");
|
showView("welcome");
|
||||||
} else {
|
} else {
|
||||||
|
|||||||
@@ -39,8 +39,8 @@ function markViewRendered(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, and
|
||||||
// asks for one when the user switches the network, because every screen
|
// asks for one after a network switch, because every screen then on the page
|
||||||
// then on the page shows the previous network (views/settings.js); the
|
// shows the previous network (showNewNetwork() in views/settings.js); the
|
||||||
// unit tests, which simulate several page loads against one module
|
// unit tests, which simulate several page loads against one module
|
||||||
// instance, ask for one too.
|
// instance, ask for one too.
|
||||||
function resetRenderedViews() {
|
function resetRenderedViews() {
|
||||||
|
|||||||
+61
-28
@@ -38,6 +38,8 @@ const {
|
|||||||
|
|
||||||
const { notify, sendMessage } = require("../../shared/browserApi");
|
const { notify, sendMessage } = require("../../shared/browserApi");
|
||||||
|
|
||||||
|
let ctx;
|
||||||
|
|
||||||
let versionClickCount = 0;
|
let versionClickCount = 0;
|
||||||
let versionClickTimer = null;
|
let versionClickTimer = null;
|
||||||
|
|
||||||
@@ -243,7 +245,51 @@ async function renderSiteLists() {
|
|||||||
);
|
);
|
||||||
}
|
}
|
||||||
|
|
||||||
function init(ctx) {
|
// 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
|
||||||
|
// the page showing the previous network. These two leave the page as README's
|
||||||
|
// Screen Map describes, the first before the switch is saved, so that save
|
||||||
|
// keeps the cut for a popup closed straight after, the second once `state`
|
||||||
|
// holds the new network.
|
||||||
|
//
|
||||||
|
// 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
|
||||||
|
// 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
|
||||||
|
// Welcome, which that cut would drop, and Welcome shows nothing from a network.
|
||||||
|
function cutViewStack() {
|
||||||
|
if (!state.hasWallet) return;
|
||||||
|
if (state.selectedToken !== "ETH") {
|
||||||
|
const tokenView = state.viewStack.indexOf("address-token");
|
||||||
|
if (tokenView !== -1) {
|
||||||
|
state.viewStack = state.viewStack.slice(0, tokenView);
|
||||||
|
}
|
||||||
|
state.selectedToken = null;
|
||||||
|
}
|
||||||
|
state.viewStack = restorableStack(state.viewStack, state.currentView);
|
||||||
|
}
|
||||||
|
|
||||||
|
// Every screen counts as not yet rendered, so "Back" renders the one it lands
|
||||||
|
// on for the new network. 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, which show nothing from a network.
|
||||||
|
function showNewNetwork() {
|
||||||
|
resetRenderedViews();
|
||||||
|
if (state.currentView === "settings") {
|
||||||
|
markViewRendered("settings");
|
||||||
|
$("settings-network").value = state.networkId;
|
||||||
|
$("settings-rpc").value = state.rpcUrl;
|
||||||
|
$("settings-blockscout").value = state.blockscoutUrl;
|
||||||
|
renderTrackedTokens();
|
||||||
|
} else if (state.hasWallet) {
|
||||||
|
ctx.restoreView();
|
||||||
|
}
|
||||||
|
updateDebugBanner(state.currentView);
|
||||||
|
}
|
||||||
|
|
||||||
|
function init(_ctx) {
|
||||||
|
ctx = _ctx;
|
||||||
deleteWallet.init(ctx);
|
deleteWallet.init(ctx);
|
||||||
showPhrase.init();
|
showPhrase.init();
|
||||||
|
|
||||||
@@ -319,37 +365,18 @@ function init(ctx) {
|
|||||||
|
|
||||||
const networkSelect = $("settings-network");
|
const networkSelect = $("settings-network");
|
||||||
networkSelect.addEventListener("change", async () => {
|
networkSelect.addEventListener("change", async () => {
|
||||||
|
// Whether `state` already has the network picked is asked only once
|
||||||
|
// the switch holds the lock: while an earlier pick waits for it,
|
||||||
|
// `state` still has the network before that pick, and a pick back to
|
||||||
|
// that network must still be made.
|
||||||
const newId = networkSelect.value;
|
const newId = networkSelect.value;
|
||||||
if (newId === state.networkId) return;
|
cutViewStack();
|
||||||
// The screens beneath Settings show the previous network, so Back
|
|
||||||
// finds them as it does in a reopened popup: each is rendered again
|
|
||||||
// when Back lands on it, and the stack is cut at the first one that
|
|
||||||
// cannot be rendered from saved state, such as Send or AddToken. It
|
|
||||||
// is cut at AddressToken too, unless that shows the native token: any
|
|
||||||
// other token there was picked on the previous network. Without a
|
|
||||||
// wallet the stack starts at Welcome, which that cut would drop, and
|
|
||||||
// Welcome shows nothing from a network. The cut comes before the
|
|
||||||
// switch so that the switch's save keeps it for a popup closed
|
|
||||||
// straight after.
|
|
||||||
if (state.hasWallet) {
|
|
||||||
const tokenView = state.viewStack.indexOf("address-token");
|
|
||||||
if (tokenView !== -1 && state.selectedToken !== "ETH") {
|
|
||||||
state.viewStack = state.viewStack.slice(0, tokenView);
|
|
||||||
}
|
|
||||||
state.viewStack = restorableStack(state.viewStack, "settings");
|
|
||||||
}
|
|
||||||
const net = await onChainSwitch(newId);
|
const net = await onChainSwitch(newId);
|
||||||
|
if (!net) return;
|
||||||
// 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 });
|
||||||
resetRenderedViews();
|
showNewNetwork();
|
||||||
// Settings itself, and the testnet banner above it, are brought up
|
|
||||||
// to date for the new network here.
|
|
||||||
markViewRendered("settings");
|
|
||||||
$("settings-rpc").value = state.rpcUrl;
|
|
||||||
$("settings-blockscout").value = state.blockscoutUrl;
|
|
||||||
renderTrackedTokens();
|
|
||||||
updateDebugBanner(state.currentView);
|
|
||||||
showFlash("Switched to " + net.name + ".");
|
showFlash("Switched to " + net.name + ".");
|
||||||
});
|
});
|
||||||
|
|
||||||
@@ -484,4 +511,10 @@ function init(ctx) {
|
|||||||
});
|
});
|
||||||
}
|
}
|
||||||
|
|
||||||
module.exports = { init, show, renderSiteLists };
|
module.exports = {
|
||||||
|
init,
|
||||||
|
show,
|
||||||
|
renderSiteLists,
|
||||||
|
cutViewStack,
|
||||||
|
showNewNetwork,
|
||||||
|
};
|
||||||
|
|||||||
@@ -24,7 +24,11 @@
|
|||||||
// than written again locally so that tests/popupElementIds.test.js sees these
|
// than written again locally so that tests/popupElementIds.test.js sees these
|
||||||
// lookups and holds every id below against the markup.
|
// lookups and holds every id below against the markup.
|
||||||
const { $, VIEWS } = require("./helpers");
|
const { $, VIEWS } = require("./helpers");
|
||||||
const { storageGet, storageRemove } = require("../../shared/browserApi");
|
const {
|
||||||
|
storageGet,
|
||||||
|
storageRemove,
|
||||||
|
withLock,
|
||||||
|
} = require("../../shared/browserApi");
|
||||||
const { log } = require("../../shared/log");
|
const { log } = require("../../shared/log");
|
||||||
|
|
||||||
// Typed in full before anything is erased, in the same spirit as the wallet
|
// Typed in full before anything is erased, in the same spirit as the wallet
|
||||||
@@ -137,7 +141,11 @@ async function resetProfile() {
|
|||||||
return;
|
return;
|
||||||
}
|
}
|
||||||
try {
|
try {
|
||||||
await storageRemove("autistmask");
|
// 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.
|
||||||
|
// 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"));
|
||||||
} catch (e) {
|
} catch (e) {
|
||||||
log.errorf("state recovery: reset failed:", e);
|
log.errorf("state recovery: reset failed:", e);
|
||||||
setFlash("The saved data could not be erased. Nothing was changed.");
|
setFlash("The saved data could not be erased. Nothing was changed.");
|
||||||
|
|||||||
+131
-19
@@ -1,4 +1,5 @@
|
|||||||
// Balance fetching: ETH balances via RPC, ERC-20 token balances via
|
// Balance fetching: ETH balances and the balances of the tokens the user
|
||||||
|
// tracks via RPC, the other ERC-20 token balances and the holder counts via
|
||||||
// Blockscout, ENS reverse lookup via RPC.
|
// Blockscout, ENS reverse lookup via RPC.
|
||||||
|
|
||||||
const {
|
const {
|
||||||
@@ -81,7 +82,9 @@ 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 }].
|
||||||
// Filters out spam: only shows tokens that are in the known token list,
|
// Filters out spam: only shows tokens that are in the known token list,
|
||||||
// explicitly tracked by the user, or have >= 1000 holders.
|
// explicitly tracked by the user, or have >= 1000 holders. A tracked token's
|
||||||
|
// balance is read through the RPC endpoint instead, and its row here gives that
|
||||||
|
// entry its holder count and `decimals` (fetchTrackedTokenBalances()).
|
||||||
//
|
//
|
||||||
// `decimals` and `balance` are each null when the answer is unknown, the same
|
// `decimals` and `balance` are each null when the answer is unknown, the same
|
||||||
// way `holders` already is. Absence is never filled in here: this is the
|
// way `holders` already is. Absence is never filled in here: this is the
|
||||||
@@ -205,8 +208,96 @@ async function fetchTokenBalances(
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
// Fetch ETH balances, ENS names, and ERC-20 token balances for all addresses.
|
// The entries at `address` of the tokens the user tracks, shaped as
|
||||||
|
// fetchTokenBalances() returns them, for the tokens the address holds.
|
||||||
|
//
|
||||||
|
// The balance is read with balanceOf through the RPC endpoint. The name and
|
||||||
|
// symbol are the tracked token's. `decimals` and `holders` are those of
|
||||||
|
// Blockscout's entry for the token in `explorerRequest`, this refresh's
|
||||||
|
// fetchTokenBalances() for the address; while Blockscout fails they are kept
|
||||||
|
// from the token's entry in `previous`, the address's entries before this
|
||||||
|
// refresh. The balance is stated at the scale the screens read the token at
|
||||||
|
// (resolveTokenDecimals()): the bundled list's, then the one the tracked token
|
||||||
|
// records, then Blockscout's, as in fetchTokenBalances().
|
||||||
|
//
|
||||||
|
// A token whose balanceOf fails keeps its entry in `previous`, as a failed ETH
|
||||||
|
// balance keeps its figure, or takes Blockscout's entry from this refresh when
|
||||||
|
// it has none. The failure is logged. A balance of zero gets no entry, as a
|
||||||
|
// zero Blockscout reports gets none: the balance lists take a tracked token's
|
||||||
|
// zero from the tracked list. A token whose symbol the spoof rule refuses gets
|
||||||
|
// no entry either, as in fetchTokenBalances().
|
||||||
|
//
|
||||||
// `signal` is as for fetchTokenBalances().
|
// `signal` is as for fetchTokenBalances().
|
||||||
|
async function fetchTrackedTokenBalances(
|
||||||
|
provider,
|
||||||
|
address,
|
||||||
|
trackedTokens,
|
||||||
|
previous,
|
||||||
|
explorerRequest,
|
||||||
|
signal,
|
||||||
|
) {
|
||||||
|
const listed = trackedTokens.filter(
|
||||||
|
(token) => !isSpoofedSymbol(token.symbol, token.address),
|
||||||
|
);
|
||||||
|
// Each token's balanceOf answer, or null where it failed.
|
||||||
|
const balances = await Promise.all(
|
||||||
|
listed.map(async (token) => {
|
||||||
|
try {
|
||||||
|
const contract = new Contract(
|
||||||
|
token.address,
|
||||||
|
ERC20_ABI,
|
||||||
|
provider,
|
||||||
|
);
|
||||||
|
return await contract.balanceOf(address);
|
||||||
|
} catch (e) {
|
||||||
|
if (!signal?.aborted) {
|
||||||
|
log.errorf(
|
||||||
|
"token balance failed",
|
||||||
|
address,
|
||||||
|
token.address,
|
||||||
|
e.shortMessage || e.message,
|
||||||
|
);
|
||||||
|
}
|
||||||
|
return null;
|
||||||
|
}
|
||||||
|
}),
|
||||||
|
);
|
||||||
|
const explorerRows = await explorerRequest;
|
||||||
|
const reported = explorerRows ?? previous;
|
||||||
|
|
||||||
|
const rows = [];
|
||||||
|
listed.forEach((token, i) => {
|
||||||
|
const lower = token.address.toLowerCase();
|
||||||
|
const entryIn = (list) =>
|
||||||
|
list.find((row) => String(row.address).toLowerCase() === lower);
|
||||||
|
const raw = balances[i];
|
||||||
|
if (raw === null) {
|
||||||
|
const kept = entryIn(previous) || entryIn(explorerRows || []);
|
||||||
|
if (kept) rows.push(kept);
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
if (raw === 0n) return;
|
||||||
|
const entry = entryIn(reported);
|
||||||
|
const decimals = entry ? entry.decimals : null;
|
||||||
|
const known = resolveTokenDecimals(lower, { trackedTokens });
|
||||||
|
const scale = known !== null ? known : decimals;
|
||||||
|
rows.push({
|
||||||
|
address: token.address,
|
||||||
|
name: token.name || "",
|
||||||
|
symbol: token.symbol || "???",
|
||||||
|
decimals: decimals,
|
||||||
|
// null when nothing knows the scale: a holding whose amount
|
||||||
|
// cannot be stated, never a zero.
|
||||||
|
balance: scale === null ? null : formatTokenBalance(raw, scale),
|
||||||
|
holders: entry ? entry.holders : null,
|
||||||
|
});
|
||||||
|
});
|
||||||
|
return rows;
|
||||||
|
}
|
||||||
|
|
||||||
|
// Fetch ETH balances, ENS names, and ERC-20 token balances for all addresses.
|
||||||
|
// `trackedTokens` are the tokens tracked on the active network. `signal` is as
|
||||||
|
// for fetchTokenBalances().
|
||||||
async function refreshBalances(
|
async function refreshBalances(
|
||||||
wallets,
|
wallets,
|
||||||
rpcUrl,
|
rpcUrl,
|
||||||
@@ -217,6 +308,8 @@ async function refreshBalances(
|
|||||||
) {
|
) {
|
||||||
log.debugf("refreshBalances start, rpc:", urlOrigin(rpcUrl));
|
log.debugf("refreshBalances start, rpc:", urlOrigin(rpcUrl));
|
||||||
const provider = getProvider(rpcUrl, networkId);
|
const provider = getProvider(rpcUrl, networkId);
|
||||||
|
const tracked = trackedTokens || [];
|
||||||
|
const trackedSet = new Set(tracked.map((t) => t.address.toLowerCase()));
|
||||||
const updates = [];
|
const updates = [];
|
||||||
|
|
||||||
for (const wallet of wallets) {
|
for (const wallet of wallets) {
|
||||||
@@ -266,23 +359,42 @@ async function refreshBalances(
|
|||||||
}),
|
}),
|
||||||
);
|
);
|
||||||
|
|
||||||
// ERC-20 token balances via Blockscout
|
// ERC-20 token balances: the tracked tokens' through the RPC
|
||||||
|
// endpoint, and from Blockscout the tokens the user has not
|
||||||
|
// tracked. When Blockscout fails, the untracked rows from before
|
||||||
|
// this refresh stay. The Blockscout request is started first and
|
||||||
|
// handed to fetchTrackedTokenBalances() too, which waits for it
|
||||||
|
// after sending its balanceOf reads, so the two run side by side.
|
||||||
|
const previous = addr.tokenBalances || [];
|
||||||
|
const explorerRequest = fetchTokenBalances(
|
||||||
|
addr.address,
|
||||||
|
blockscoutUrl,
|
||||||
|
tracked,
|
||||||
|
signal,
|
||||||
|
);
|
||||||
updates.push(
|
updates.push(
|
||||||
fetchTokenBalances(
|
Promise.all([
|
||||||
addr.address,
|
fetchTrackedTokenBalances(
|
||||||
blockscoutUrl,
|
provider,
|
||||||
trackedTokens,
|
addr.address,
|
||||||
signal,
|
tracked,
|
||||||
).then((balances) => {
|
previous,
|
||||||
if (balances !== null) {
|
explorerRequest,
|
||||||
addr.tokenBalances = balances;
|
signal,
|
||||||
log.debugf(
|
),
|
||||||
"Token balances",
|
explorerRequest,
|
||||||
addr.address,
|
]).then(([trackedRows, explorerRows]) => {
|
||||||
balances.length,
|
const untrackedRows = (explorerRows ?? previous).filter(
|
||||||
"tokens",
|
(row) =>
|
||||||
);
|
!trackedSet.has(String(row.address).toLowerCase()),
|
||||||
}
|
);
|
||||||
|
addr.tokenBalances = trackedRows.concat(untrackedRows);
|
||||||
|
log.debugf(
|
||||||
|
"Token balances",
|
||||||
|
addr.address,
|
||||||
|
addr.tokenBalances.length,
|
||||||
|
"tokens",
|
||||||
|
);
|
||||||
}),
|
}),
|
||||||
);
|
);
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -31,6 +31,11 @@
|
|||||||
// Everything is resolved on use rather than captured at module load. The MV3
|
// Everything is resolved on use rather than captured at module load. The MV3
|
||||||
// service worker is torn down and re-evaluated repeatedly, and the unit
|
// service worker is torn down and re-evaluated repeatedly, and the unit
|
||||||
// suite installs its stubs on `global.chrome` around a require().
|
// suite installs its stubs on `global.chrome` around a require().
|
||||||
|
//
|
||||||
|
// The module also holds withLock(), a wrapper around the browser's
|
||||||
|
// `navigator.locks`, which is in neither namespace. It sits beside
|
||||||
|
// storageGet() and storageSet() because every write of the stored record
|
||||||
|
// takes it.
|
||||||
|
|
||||||
// The extension API namespace, preferring `browser.*` where it exists.
|
// The extension API namespace, preferring `browser.*` where it exists.
|
||||||
//
|
//
|
||||||
@@ -219,6 +224,46 @@ function storageRemove(keys) {
|
|||||||
return Promise.resolve(storage.remove(keys));
|
return Promise.resolve(storage.remove(keys));
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Call `listener` after every write to `storage.local`, whether this page,
|
||||||
|
* another page or the background made it, with what the write changed, as the
|
||||||
|
* browser reports it: `{ [key]: { oldValue, newValue } }`.
|
||||||
|
*
|
||||||
|
* @param {function(Object): void} listener
|
||||||
|
*/
|
||||||
|
function onStorageChanged(listener) {
|
||||||
|
namespaceMember("storage").onChanged.addListener((changes, areaName) => {
|
||||||
|
if (areaName === "local") listener(changes);
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Run `fn` while holding the browser's lock called `name`
|
||||||
|
* (`navigator.locks`), and settle as `fn` settles. Every page of the extension
|
||||||
|
* and its background share these locks, except a page in a Firefox private
|
||||||
|
* window (README, "Stored state and its version"), so while one of them holds
|
||||||
|
* `name` another asking for it waits, in the order they asked. The lock is let
|
||||||
|
* go when `fn` settles, whether it resolved or rejected.
|
||||||
|
*
|
||||||
|
* Every write of the stored record holds the lock named after its key,
|
||||||
|
* "autistmask", from its read to its write: saveState() in
|
||||||
|
* src/shared/state.js, updateState() in src/background/state.js, and the
|
||||||
|
* reset in src/popup/views/stateRecovery.js.
|
||||||
|
*
|
||||||
|
* @param {string} name
|
||||||
|
* @param {function(): Promise<*>} fn
|
||||||
|
* @returns {Promise<*>} what `fn` resolved with.
|
||||||
|
* @throws rejects, without running `fn`, where `navigator.locks` is absent.
|
||||||
|
*/
|
||||||
|
function withLock(name, fn) {
|
||||||
|
if (typeof navigator === "undefined" || !navigator.locks) {
|
||||||
|
return Promise.reject(
|
||||||
|
new Error("navigator.locks is not available in this context"),
|
||||||
|
);
|
||||||
|
}
|
||||||
|
return navigator.locks.request(name, () => fn());
|
||||||
|
}
|
||||||
|
|
||||||
// `storage.session`, the browser's session storage: what is kept there lasts
|
// `storage.session`, the browser's session storage: what is kept there lasts
|
||||||
// until the browser closes. It survives the background worker being stopped
|
// until the browser closes. It survives the background worker being stopped
|
||||||
// and started again, which module-level variables do not (README, Background
|
// and started again, which module-level variables do not (README, Background
|
||||||
@@ -353,6 +398,7 @@ module.exports = {
|
|||||||
getPlatformInfo,
|
getPlatformInfo,
|
||||||
hasBrowserNamespace,
|
hasBrowserNamespace,
|
||||||
notify,
|
notify,
|
||||||
|
onStorageChanged,
|
||||||
runtimeApi,
|
runtimeApi,
|
||||||
sendMessage,
|
sendMessage,
|
||||||
sessionStorageGet,
|
sessionStorageGet,
|
||||||
@@ -373,4 +419,5 @@ module.exports = {
|
|||||||
windowsGetLastFocused,
|
windowsGetLastFocused,
|
||||||
windowsRemove,
|
windowsRemove,
|
||||||
windowsUpdate,
|
windowsUpdate,
|
||||||
|
withLock,
|
||||||
};
|
};
|
||||||
|
|||||||
+37
-17
@@ -1,8 +1,18 @@
|
|||||||
// Consolidated chain-switch handler for the popup.
|
// The popup's network switch.
|
||||||
//
|
//
|
||||||
// Every state change required when the active network changes is
|
// A network switch reaches the popup's `state` in one of two ways:
|
||||||
// performed here so that callers (settings UI, future chain additions) all go
|
//
|
||||||
// through a single code path.
|
// - onChainSwitch() below makes the switch the user picks in Settings, with
|
||||||
|
// applyChainSwitchFields() (chainSwitchFields.js).
|
||||||
|
// - followNetworkSwitch() in src/popup/index.js takes a switch the background
|
||||||
|
// or another popup page saved, from the stored record, with
|
||||||
|
// takeStoredNetwork() (state.js), which copies it with
|
||||||
|
// copyChainSwitchFields() (chainSwitchFields.js).
|
||||||
|
//
|
||||||
|
// Both change `state` inside a save, holding the lock, and both reset the
|
||||||
|
// popup's own caches through clearPopupCaches(), so a reset added there
|
||||||
|
// reaches both. A field applyChainSwitchFields() sets has to be copied by
|
||||||
|
// copyChainSwitchFields() too.
|
||||||
//
|
//
|
||||||
// Adding a new chain (e.g. ETC) requires only a new entry in
|
// Adding a new chain (e.g. ETC) requires only a new entry in
|
||||||
// networks.js — no per-caller wiring is needed.
|
// networks.js — no per-caller wiring is needed.
|
||||||
@@ -20,22 +30,32 @@
|
|||||||
const { applyChainSwitchFields } = require("./chainSwitchFields");
|
const { applyChainSwitchFields } = require("./chainSwitchFields");
|
||||||
const { clearPrices } = require("./prices");
|
const { clearPrices } = require("./prices");
|
||||||
|
|
||||||
|
// The popup's own caches a network switch resets. Prices are chain-specific
|
||||||
|
// (testnet tokens are worthless, ETC has different pricing, etc.). In-memory
|
||||||
|
// and per bundle, so this is the popup's own cache — the only context that
|
||||||
|
// ever fills it.
|
||||||
|
function clearPopupCaches() {
|
||||||
|
clearPrices();
|
||||||
|
}
|
||||||
|
|
||||||
// Switch the active chain and reset all chain-specific cached state.
|
// Switch the active chain and reset all chain-specific cached state.
|
||||||
// Returns the network configuration object for the new chain.
|
// Returns the network configuration object for the new chain, or null when
|
||||||
|
// `state` already has that network once the save holds the lock, and nothing
|
||||||
|
// is switched.
|
||||||
|
//
|
||||||
|
// `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
|
||||||
|
// waits for the lock (followNetworkSwitch() in src/popup/index.js): that
|
||||||
|
// follow runs first, and this switch is made after it.
|
||||||
async function onChainSwitch(newNetworkId) {
|
async function onChainSwitch(newNetworkId) {
|
||||||
const { state, saveState } = require("./state");
|
const { state, saveState } = require("./state");
|
||||||
|
let net = null;
|
||||||
const net = applyChainSwitchFields(state, newNetworkId);
|
await saveState(() => {
|
||||||
|
if (state.networkId === newNetworkId) return false;
|
||||||
// --- price cache ---
|
net = applyChainSwitchFields(state, newNetworkId);
|
||||||
// Prices are chain-specific (testnet tokens are worthless,
|
clearPopupCaches();
|
||||||
// ETC has different pricing, etc.). In-memory and per bundle, so this is
|
});
|
||||||
// the popup's own cache — the only context that ever fills it.
|
|
||||||
clearPrices();
|
|
||||||
|
|
||||||
await saveState();
|
|
||||||
|
|
||||||
return net;
|
return net;
|
||||||
}
|
}
|
||||||
|
|
||||||
module.exports = { onChainSwitch };
|
module.exports = { onChainSwitch, clearPopupCaches };
|
||||||
|
|||||||
@@ -7,7 +7,7 @@
|
|||||||
// the singleton and saves; the background applies it to the detached record of
|
// the singleton and saves; the background applies it to the detached record of
|
||||||
// its own read-modify-write (src/background/state.js).
|
// its own read-modify-write (src/background/state.js).
|
||||||
//
|
//
|
||||||
// Everything here is synchronous and touches nothing but the object it is
|
// Everything here is synchronous and touches nothing but the objects it is
|
||||||
// given: no storage, no caches, no imports beyond the network table. That is
|
// given: no storage, no caches, no imports beyond the network table. That is
|
||||||
// what makes it usable on a record that has been read fresh from storage
|
// what makes it usable on a record that has been read fresh from storage
|
||||||
// microseconds earlier and is about to be written back.
|
// microseconds earlier and is about to be written back.
|
||||||
@@ -76,4 +76,33 @@ function applyChainSwitchFields(s, newNetworkId) {
|
|||||||
return net;
|
return net;
|
||||||
}
|
}
|
||||||
|
|
||||||
module.exports = { applyChainSwitchFields };
|
// Give `s` every field applyChainSwitchFields() sets, as `switched` holds it:
|
||||||
|
// the popup takes a switch the background saved from the stored record this
|
||||||
|
// way, rather than performing it again (takeStoredNetwork() in
|
||||||
|
// src/shared/state.js). Balances are taken by address, and an address
|
||||||
|
// `switched` does not have keeps none.
|
||||||
|
function copyChainSwitchFields(s, switched) {
|
||||||
|
s.networkEndpoints = switched.networkEndpoints;
|
||||||
|
s.networkTrackedTokens = switched.networkTrackedTokens;
|
||||||
|
s.trackedTokens = switched.trackedTokens;
|
||||||
|
s.networkId = switched.networkId;
|
||||||
|
s.rpcUrl = switched.rpcUrl;
|
||||||
|
s.blockscoutUrl = switched.blockscoutUrl;
|
||||||
|
s.lastBalanceRefresh = switched.lastBalanceRefresh;
|
||||||
|
s.tokenHolderCache = switched.tokenHolderCache;
|
||||||
|
s.fraudContracts = switched.fraudContracts;
|
||||||
|
|
||||||
|
const stored = new Map();
|
||||||
|
for (const wallet of switched.wallets) {
|
||||||
|
for (const addr of wallet.addresses) stored.set(addr.address, addr);
|
||||||
|
}
|
||||||
|
for (const wallet of s.wallets) {
|
||||||
|
for (const addr of wallet.addresses) {
|
||||||
|
const got = stored.get(addr.address);
|
||||||
|
addr.balance = got ? got.balance : "0";
|
||||||
|
addr.tokenBalances = got ? got.tokenBalances : [];
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
module.exports = { applyChainSwitchFields, copyChainSwitchFields };
|
||||||
|
|||||||
+56
-37
@@ -23,6 +23,7 @@
|
|||||||
// guarantee.
|
// guarantee.
|
||||||
|
|
||||||
const { networkById } = require("./networks");
|
const { networkById } = require("./networks");
|
||||||
|
const { copyChainSwitchFields } = require("./chainSwitchFields");
|
||||||
const {
|
const {
|
||||||
DEFAULT_STATE,
|
DEFAULT_STATE,
|
||||||
PERSISTED_FIELDS,
|
PERSISTED_FIELDS,
|
||||||
@@ -35,7 +36,7 @@ const {
|
|||||||
migrationNeeded,
|
migrationNeeded,
|
||||||
} = require("./stateSchema");
|
} = require("./stateSchema");
|
||||||
|
|
||||||
const { storageGet, storageSet } = require("./browserApi");
|
const { storageGet, storageSet, withLock } = require("./browserApi");
|
||||||
const { log } = require("./log");
|
const { log } = require("./log");
|
||||||
|
|
||||||
// The live record the proxy below guards. Everything inside this module reads
|
// The live record the proxy below guards. Everything inside this module reads
|
||||||
@@ -125,8 +126,10 @@ function currentNetwork() {
|
|||||||
}
|
}
|
||||||
|
|
||||||
// The persisted fields as this page held them when its last loadState()
|
// The persisted fields as this page held them when its last loadState()
|
||||||
// finished, or when its last successful saveState() began. saveState() diffs
|
// finished, or when its last successful saveState() began, with any network
|
||||||
// the live state against this to find only the fields THIS page changed since.
|
// switch saved elsewhere that this page has taken since (takeStoredNetwork()).
|
||||||
|
// saveState() diffs the live state against this to find only the fields THIS
|
||||||
|
// page changed since.
|
||||||
//
|
//
|
||||||
// Deep-cloned, not a reference: callers mutate persisted objects and arrays
|
// Deep-cloned, not a reference: callers mutate persisted objects and arrays
|
||||||
// in place (state.wallets.push(...)), and a reference baseline would mutate
|
// in place (state.wallets.push(...)), and a reference baseline would mutate
|
||||||
@@ -458,20 +461,18 @@ function mergeNetworkEndpoints(base, ours, theirs) {
|
|||||||
// This page's own live `state` is deliberately NOT rehydrated from a field
|
// This page's own live `state` is deliberately NOT rehydrated from a field
|
||||||
// another page changed — only the record written to storage is merged.
|
// another page changed — only the record written to storage is merged.
|
||||||
// showView() fires saveState() on every navigation without awaiting it,
|
// showView() fires saveState() on every navigation without awaiting it,
|
||||||
// which is what makes the queue above necessary in the first place, and a
|
// which is why saves from one page wait for each other (see saveState()), and
|
||||||
// save that is slow to come back has no way to tell whether the field it
|
// a save that is slow to come back has no way to tell whether the field it
|
||||||
// is about to hand back is still the current answer or has since been
|
// is about to hand back is still the current answer or has since been
|
||||||
// overtaken by something this very page did in the meantime; writing it
|
// overtaken by something this very page did in the meantime; writing it
|
||||||
// into `state` regardless reintroduced exactly the clobber this function
|
// into `state` regardless reintroduced exactly the clobber this function
|
||||||
// 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.
|
// before this fix; only the persisted record is guaranteed current. The
|
||||||
async function saveStateOnce() {
|
// network is the exception: the popup takes a switch another context saved
|
||||||
// A copy, so what this save compares and writes is the page's state as it
|
// through `beforeWrite` (followNetworkSwitch() in src/popup/index.js).
|
||||||
// stood when the save began. A change made while it waits on storage is
|
async function saveStateOnce(beforeWrite) {
|
||||||
// left for the next save, which compares against this copy.
|
|
||||||
const current = structuredClone(snapshotPersisted());
|
|
||||||
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
|
||||||
// back, so it is validated exactly like a load validates it. Without this,
|
// back, so it is validated exactly like a load validates it. Without this,
|
||||||
@@ -485,6 +486,12 @@ async function saveStateOnce() {
|
|||||||
// come from storage in its loaded (self-healed) shape. See
|
// come from storage in its loaded (self-healed) shape. See
|
||||||
// normalizePersisted() in persistedState.js.
|
// normalizePersisted() in persistedState.js.
|
||||||
const fresh = normalizePersisted(result.autistmask);
|
const fresh = normalizePersisted(result.autistmask);
|
||||||
|
if (beforeWrite && beforeWrite(fresh) === false) return;
|
||||||
|
|
||||||
|
// A copy, so what this save compares and writes is the page's state as it
|
||||||
|
// stood once the stored record was read. A change made while it waits on
|
||||||
|
// the write is left for the next save, which compares against this copy.
|
||||||
|
const current = structuredClone(snapshotPersisted());
|
||||||
|
|
||||||
const merged = { ...fresh };
|
const merged = { ...fresh };
|
||||||
for (const key of PERSISTED_FIELDS) {
|
for (const key of PERSISTED_FIELDS) {
|
||||||
@@ -529,35 +536,21 @@ async function saveStateOnce() {
|
|||||||
rawState.hasWallet = rawState.wallets.length > 0;
|
rawState.hasWallet = rawState.wallets.length > 0;
|
||||||
|
|
||||||
// What this save compared and wrote, not the page's state now: a change
|
// What this save compared and wrote, not the page's state now: a change
|
||||||
// made during the save must still differ from the baseline, or the save
|
// made during the save must still differ from the baseline, or the next
|
||||||
// queued after it finds nothing to store
|
// save finds nothing to store
|
||||||
// (https://git.eeqj.de/sneak/AutistMask/issues/448).
|
// (https://git.eeqj.de/sneak/AutistMask/issues/448).
|
||||||
baseline = current;
|
baseline = current;
|
||||||
}
|
}
|
||||||
|
|
||||||
// showView() calls saveState() on every navigation without awaiting it, so
|
|
||||||
// two saves from the SAME page can be in flight at once — e.g. a screen
|
|
||||||
// shown, then immediately replaced before the first save's storageGet()
|
|
||||||
// round trip has come back. Left concurrent, the first save's turn would
|
|
||||||
// finish after the second's live-state mutation and then re-hydrate `state`
|
|
||||||
// from what IT read, stomping the second, later change back to a stale
|
|
||||||
// value — the same clobber this function exists to prevent, just between
|
|
||||||
// two saves on one page instead of two pages. Queuing makes every save's
|
|
||||||
// snapshot-diff-write-rehydrate run start to finish before the next one
|
|
||||||
// begins, so each one only ever sees the true live state at its turn.
|
|
||||||
let saveQueue = Promise.resolve();
|
|
||||||
|
|
||||||
// Where a failed save is REPORTED, set once by the context that has a screen
|
// Where a failed save is REPORTED, set once by the context that has a screen
|
||||||
// to say it on (src/popup/index.js).
|
// to say it on (src/popup/index.js).
|
||||||
//
|
//
|
||||||
// A save that fails must not fail silently. showView() fires saveState() on
|
// A save that fails must not fail silently. showView() fires saveState() on
|
||||||
// every navigation without awaiting it, and the queue below has to attach a
|
// every navigation without awaiting it, and `await saveState()` inside an
|
||||||
// rejection handler to keep advancing — so a failing save was swallowed
|
// unguarded event handler is no better: either way, without this, a failure
|
||||||
// entirely: no throw, no message, nothing on screen. The wallet kept running
|
// would reach only the console, where the user never looks, and the wallet
|
||||||
// against storage that was rejecting every write, which is the data-loss half
|
// would keep running against storage that rejects every write. That is the
|
||||||
// of https://git.eeqj.de/sneak/AutistMask/issues/362. The awaited callers were
|
// data-loss half of https://git.eeqj.de/sneak/AutistMask/issues/362.
|
||||||
// no better off: `await saveState()` inside an unguarded event handler surfaces
|
|
||||||
// in the console and nowhere the user looks.
|
|
||||||
//
|
//
|
||||||
// This is the "tell the user" half; the other half is the floor in
|
// This is the "tell the user" half; the other half is the floor in
|
||||||
// normalizePersisted(), which stops the malformed-record cause from arising in
|
// normalizePersisted(), which stops the malformed-record cause from arising in
|
||||||
@@ -583,11 +576,25 @@ function reportSaveFailure(err) {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
function saveState() {
|
// Each save runs start to finish holding the lock every write of the stored
|
||||||
const turn = saveQueue.then(saveStateOnce);
|
// record takes (withLock() in src/shared/browserApi.js), so no write by
|
||||||
// The queue must advance even when a save rejects, or every save after
|
// another page or the background lands between its read and its write and is
|
||||||
// it queues behind a promise that never settles.
|
// lost (https://git.eeqj.de/sneak/AutistMask/issues/641). A page in a Firefox
|
||||||
saveQueue = turn.catch(() => {});
|
// 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
|
||||||
|
// every navigation without awaiting it, so two saves from one page can be
|
||||||
|
// asked for at once; they take the lock in the order they were asked, and each
|
||||||
|
// compares the page's state, as it stands once the stored record has been read
|
||||||
|
// and `beforeWrite` has run, against the baseline the save before it left.
|
||||||
|
//
|
||||||
|
// `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
|
||||||
|
// `state`, and this save writes that change. When it returns false, nothing is
|
||||||
|
// written; any other return lets the save go ahead.
|
||||||
|
function saveState(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
|
||||||
// one. The returned promise still rejects, so a caller that DOES await
|
// one. The returned promise still rejects, so a caller that DOES await
|
||||||
// keeps its own error handling.
|
// keeps its own error handling.
|
||||||
@@ -595,6 +602,17 @@ function saveState() {
|
|||||||
return turn;
|
return turn;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// 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
|
||||||
|
// 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
|
||||||
|
// that save fails to write: a later switch back to the previous network still
|
||||||
|
// differs from `baseline`, and is stored.
|
||||||
|
function takeStoredNetwork(stored) {
|
||||||
|
copyChainSwitchFields(rawState, stored);
|
||||||
|
copyChainSwitchFields(baseline, structuredClone(stored));
|
||||||
|
}
|
||||||
|
|
||||||
// Rejects with StateUnusableError for a stored record this build cannot make
|
// Rejects with StateUnusableError for a stored record this build cannot make
|
||||||
// sense of. Nothing is assigned and `loaded` stays false in that case, so a
|
// sense of. Nothing is assigned and `loaded` stays false in that case, so a
|
||||||
// caller that ignores the rejection gets StateNotLoadedError on the first
|
// caller that ignores the rejection gets StateNotLoadedError on the first
|
||||||
@@ -640,6 +658,7 @@ module.exports = {
|
|||||||
state,
|
state,
|
||||||
saveState,
|
saveState,
|
||||||
onSaveFailure,
|
onSaveFailure,
|
||||||
|
takeStoredNetwork,
|
||||||
loadState,
|
loadState,
|
||||||
currentAddress,
|
currentAddress,
|
||||||
currentNetwork,
|
currentNetwork,
|
||||||
|
|||||||
+299
-72
@@ -336,7 +336,8 @@ const UNNAMED_CURRENCY = "Unknown (not named in the calldata)";
|
|||||||
// currencies, and those commands may name one, so saying the calldata did not
|
// currencies, and those commands may name one, so saying the calldata did not
|
||||||
// name it would be false. The Paid to line uses it too, when a step may pay an
|
// name it would be false. The Paid to line uses it too, when a step may pay an
|
||||||
// address this decoder did not read, and so do the lines for what a step
|
// address this decoder did not read, and so do the lines for what a step
|
||||||
// takes from the sender, when this decoder does not know it.
|
// takes from the sender, when this decoder does not know it, and for what a
|
||||||
|
// permit it could not read allows.
|
||||||
const UNDECODED_CURRENCY = "Unknown (could not be decoded)";
|
const UNDECODED_CURRENCY = "Unknown (could not be decoded)";
|
||||||
|
|
||||||
// The Paid to line for each token paid to the router, the swap's output or
|
// The Paid to line for each token paid to the router, the swap's output or
|
||||||
@@ -494,8 +495,9 @@ function amountText(raw, info) {
|
|||||||
};
|
};
|
||||||
}
|
}
|
||||||
|
|
||||||
// The line giving a moved token under `label`, in the shape of the Token In
|
// The line giving a moved token, or the token of a permit, under `label`, in
|
||||||
// line, so the screens show it as they show that one. ETH has no address.
|
// the shape of the Token In line, so the screens show it as they show that
|
||||||
|
// one. ETH has no address.
|
||||||
function tokenMovedLine(label, token, sources) {
|
function tokenMovedLine(label, token, sources) {
|
||||||
const info = tokenInfo(token, sources);
|
const info = tokenInfo(token, sources);
|
||||||
if (!present(info.address)) {
|
if (!present(info.address)) {
|
||||||
@@ -527,6 +529,32 @@ function decodePermit2(input) {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// Decode PERMIT2_PERMIT_BATCH (command 0x03) input bytes into the allowances
|
||||||
|
// it grants, one for each token it names, all for its one spender, in the
|
||||||
|
// shape decodePermit2() returns. Each release's
|
||||||
|
// `contracts/base/Dispatcher.sol`, at the commit linked for it above, hands
|
||||||
|
// Permit2 the batch in this shape.
|
||||||
|
// ABI: (((address token, uint160 amount, uint48 expiration, uint48 nonce)[],
|
||||||
|
// address spender, uint256 sigDeadline), bytes signature)
|
||||||
|
function decodePermit2Batch(input) {
|
||||||
|
try {
|
||||||
|
const d = coder.decode(
|
||||||
|
[
|
||||||
|
"tuple(tuple(address,uint160,uint48,uint48)[],address,uint256)",
|
||||||
|
"bytes",
|
||||||
|
],
|
||||||
|
input,
|
||||||
|
);
|
||||||
|
return d[0][0].map((details) => ({
|
||||||
|
token: details[0],
|
||||||
|
amount: details[1],
|
||||||
|
spender: d[0][1],
|
||||||
|
}));
|
||||||
|
} catch {
|
||||||
|
return null;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
// Decode BALANCE_CHECK_ERC20 (command 0x0e) input bytes. The router passes the
|
// Decode BALANCE_CHECK_ERC20 (command 0x0e) input bytes. The router passes the
|
||||||
// check when `owner` holds at least `minBalance` of `token`, and reads `owner`
|
// check when `owner` holds at least `minBalance` of `token`, and reads `owner`
|
||||||
// as written, without map(), on every release that has the command:
|
// as written, without map(), on every release that has the command:
|
||||||
@@ -596,12 +624,14 @@ function decodeV2SwapExactOut(input) {
|
|||||||
// token(20) ...), or null when it is not one token followed by whole hops of
|
// token(20) ...), or null when it is not one token followed by whole hops of
|
||||||
// a fee and a token (40 hex digits, then 46 per hop). The router reads only
|
// a fee and a token (40 hex digits, then 46 per hop). The router reads only
|
||||||
// whole hops and ignores any bytes after the last one, so the last 20 bytes
|
// whole hops and ignores any bytes after the last one, so the last 20 bytes
|
||||||
// of such a path are not the token it reads there.
|
// of such a path are not the token it reads there. Both are checksummed, as
|
||||||
|
// the ABI decoder gives every other address, so a token reads the same on
|
||||||
|
// every line.
|
||||||
function decodeV3Path(pathHex) {
|
function decodeV3Path(pathHex) {
|
||||||
const hex = pathHex.startsWith("0x") ? pathHex.slice(2) : pathHex;
|
const hex = pathHex.startsWith("0x") ? pathHex.slice(2) : pathHex;
|
||||||
if (hex.length < 40 || (hex.length - 40) % 46 !== 0) return null;
|
if (hex.length < 40 || (hex.length - 40) % 46 !== 0) return null;
|
||||||
const first = "0x" + hex.slice(0, 40);
|
const first = getAddress("0x" + hex.slice(0, 40));
|
||||||
const last = "0x" + hex.slice(-40);
|
const last = getAddress("0x" + hex.slice(-40));
|
||||||
return { first, last };
|
return { first, last };
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -923,7 +953,9 @@ function totalAmount(amounts) {
|
|||||||
// 2. Amount is the amountIn of the swap action that spends Token In. If
|
// 2. Amount is the amountIn of the swap action that spends Token In. If
|
||||||
// several exact-in actions spend it, each with a stated amount, it is
|
// several exact-in actions spend it, each with a stated amount, it is
|
||||||
// their sum; in any other case there is none. Min. received is the same
|
// their sum; in any other case there is none. Min. received is the same
|
||||||
// for amountOutMin and the actions that buy Token Out.
|
// for amountOutMin and the actions that buy Token Out, except that there
|
||||||
|
// is none when a swap action in the step also spends Token Out: the step
|
||||||
|
// then does not pay out all that those actions buy.
|
||||||
// 3. If any swap action in the step cannot be read, only SETTLE, SETTLE_ALL,
|
// 3. If any swap action in the step cannot be read, only SETTLE, SETTLE_ALL,
|
||||||
// TAKE and TAKE_ALL name the sides, and there is no Amount or Min.
|
// TAKE and TAKE_ALL name the sides, and there is no Amount or Min.
|
||||||
// received.
|
// received.
|
||||||
@@ -1157,11 +1189,13 @@ function decodeV4Swap(input) {
|
|||||||
const boughtOnly = currenciesNotIn(bought, spent);
|
const boughtOnly = currenciesNotIn(bought, spent);
|
||||||
if (present(takeToken) || boughtOnly.length === 1) {
|
if (present(takeToken) || boughtOnly.length === 1) {
|
||||||
tokenOut = present(takeToken) ? takeToken : boughtOnly[0];
|
tokenOut = present(takeToken) ? takeToken : boughtOnly[0];
|
||||||
amountOutMin = totalAmount(
|
if (!spent.includes(tokenOut)) {
|
||||||
swaps
|
amountOutMin = totalAmount(
|
||||||
.filter((s) => s.tokenOut === tokenOut)
|
swaps
|
||||||
.map((s) => s.amountOutMin),
|
.filter((s) => s.tokenOut === tokenOut)
|
||||||
);
|
.map((s) => s.amountOutMin),
|
||||||
|
);
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
return {
|
return {
|
||||||
@@ -1204,13 +1238,22 @@ function decode(data, toAddress, chainId, sources, fromAddress) {
|
|||||||
let inputToken = null;
|
let inputToken = null;
|
||||||
let inputAmount = null;
|
let inputAmount = null;
|
||||||
let inputEstablished = false;
|
let inputEstablished = false;
|
||||||
// Whether the user pays the V4 step that set the input side any of
|
// Whether the user pays the step that set the input side: a V2 or V3
|
||||||
// its input currency (see decodeV4Swap()). Only a V4 step can set the
|
// swap step with `payerIsUser` true, a V4 step the user pays some of
|
||||||
// input side with no amount, the one case in which this is read.
|
// its input currency (see decodeV4Swap()), or a WRAP_ETH, whose ETH
|
||||||
|
// comes from the transaction's value. A step paid from the router
|
||||||
|
// takes nothing from the sender.
|
||||||
let inputPaidByUser = false;
|
let inputPaidByUser = false;
|
||||||
// The last PERMIT2_PERMIT this decoder read, or null (see
|
// The last PERMIT2_PERMIT this decoder read before a step set the
|
||||||
// permitStands after the loop).
|
// input side, or null (see permitStands after the loop).
|
||||||
let permit = null;
|
let permit = null;
|
||||||
|
// Every allowance a PERMIT2_PERMIT or PERMIT2_PERMIT_BATCH grants,
|
||||||
|
// before a step set the input side or after, in step order, as
|
||||||
|
// { token, amount, spender, step }. A permit or batch whose input
|
||||||
|
// this decoder cannot read is one with a null token, amount and
|
||||||
|
// spender. Each but a permit whose amount is the Amount figure gets
|
||||||
|
// lines of its own (see after the PERMIT2_TRANSFER_FROM lines).
|
||||||
|
const permits = [];
|
||||||
// The index of each step this decoder did not read in full: a
|
// The index of each step this decoder did not read in full: a
|
||||||
// command it does not read, a step whose input it cannot read, in
|
// command it does not read, a step whose input it cannot read, in
|
||||||
// whole or in part, and one it fails on (see permitStands).
|
// whole or in part, and one it fails on (see permitStands).
|
||||||
@@ -1221,8 +1264,23 @@ function decode(data, toAddress, chainId, sources, fromAddress) {
|
|||||||
let hasUnwrapWeth = false;
|
let hasUnwrapWeth = false;
|
||||||
// Set when an UNWRAP_WETH pays out, as ETH, the output side's WETH,
|
// Set when an UNWRAP_WETH pays out, as ETH, the output side's WETH,
|
||||||
// which the router holds; cleared whenever the output side is set
|
// which the router holds; cleared whenever the output side is set
|
||||||
// again.
|
// again, or a later step may pay that ETH out as WETH (see after the
|
||||||
|
// loop). `unwrapIntoRouterStep` is the index of the first such
|
||||||
|
// UNWRAP_WETH that may have paid the ETH to the router, which then
|
||||||
|
// holds it: its recipient is the router or cannot be read. A later
|
||||||
|
// UNWRAP_WETH does not replace it. It is null when there is none, and
|
||||||
|
// is cleared with `outputUnwrapped` when the output side is set again.
|
||||||
let outputUnwrapped = false;
|
let outputUnwrapped = false;
|
||||||
|
let unwrapIntoRouterStep = null;
|
||||||
|
// The index of the step that set the output side.
|
||||||
|
let outputStep = -1;
|
||||||
|
// The index of the last step this decoder treats as one that may take
|
||||||
|
// WETH out of the router or pay anyone WETH: any step but one it read
|
||||||
|
// that is a PERMIT2_PERMIT, a BALANCE_CHECK_ERC20, or a SWEEP,
|
||||||
|
// TRANSFER, PAY_PORTION or PAY_PORTION_FULL_PRECISION of a token
|
||||||
|
// other than WETH, and not of ETH to a WETH contract, which pays the
|
||||||
|
// router WETH (see keepsRouterWeth in the loop). None of those can.
|
||||||
|
let lastWethStep = -1;
|
||||||
// Where the step that set the output side paid its output: the
|
// Where the step that set the output side paid its output: the
|
||||||
// recipient of a swap step, as written, or of each TAKE, TAKE_ALL and
|
// recipient of a swap step, as written, or of each TAKE, TAKE_ALL and
|
||||||
// TAKE_PORTION of it in a V4 step, a TAKE_ALL as paid to the sender,
|
// TAKE_PORTION of it in a V4 step, a TAKE_ALL as paid to the sender,
|
||||||
@@ -1253,8 +1311,9 @@ function decode(data, toAddress, chainId, sources, fromAddress) {
|
|||||||
// when no earlier hop set it. A half the establishing hop did not
|
// when no earlier hop set it. A half the establishing hop did not
|
||||||
// state stays null and the line says so, rather than being filled in
|
// state stays null and the line says so, rather than being filled in
|
||||||
// from a different hop. A PERMIT2_PERMIT sets no side here: after the
|
// from a different hop. A PERMIT2_PERMIT sets no side here: after the
|
||||||
// loop, the last one read names Token In, and the Amount line is
|
// loop, one whose amount stands as the Amount figure names Token In,
|
||||||
// formed there, in one place (see permitStands).
|
// and the Amount line is formed there, in one place (see
|
||||||
|
// permitStands).
|
||||||
const setInput = (token, amount) => {
|
const setInput = (token, amount) => {
|
||||||
inputToken = present(token) ? token : null;
|
inputToken = present(token) ? token : null;
|
||||||
inputAmount = present(amount) ? amount : null;
|
inputAmount = present(amount) ? amount : null;
|
||||||
@@ -1265,13 +1324,15 @@ function decode(data, toAddress, chainId, sources, fromAddress) {
|
|||||||
if (!present(token) && !present(amount)) return;
|
if (!present(token) && !present(amount)) return;
|
||||||
setInput(token, amount);
|
setInput(token, amount);
|
||||||
};
|
};
|
||||||
const setOutput = (token, amount, recipients) => {
|
const setOutput = (step, token, amount, recipients) => {
|
||||||
if (!present(token) && !present(amount)) return;
|
if (!present(token) && !present(amount)) return;
|
||||||
outputToken = present(token) ? token : null;
|
outputToken = present(token) ? token : null;
|
||||||
minOutput = present(amount) ? amount : null;
|
minOutput = present(amount) ? amount : null;
|
||||||
outputEstablished = true;
|
outputEstablished = true;
|
||||||
outputUnwrapped = false;
|
outputUnwrapped = false;
|
||||||
|
unwrapIntoRouterStep = null;
|
||||||
outputRecipients = recipients;
|
outputRecipients = recipients;
|
||||||
|
outputStep = step;
|
||||||
};
|
};
|
||||||
|
|
||||||
// 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
|
||||||
@@ -1296,6 +1357,15 @@ function decode(data, toAddress, chainId, sources, fromAddress) {
|
|||||||
const spentUnread = () => {
|
const spentUnread = () => {
|
||||||
userPaid.push({ token: null, amount: null });
|
userPaid.push({ token: null, amount: null });
|
||||||
};
|
};
|
||||||
|
// A PERMIT2_PERMIT or PERMIT2_PERMIT_BATCH at `step` whose input this
|
||||||
|
// decoder cannot read may let any spender take any amount of any
|
||||||
|
// token: one line says so, there is no Amount line, whose figure may
|
||||||
|
// then be too low, and the minimum reads Min. paid out (see
|
||||||
|
// toAnotherSpender).
|
||||||
|
const permitUnread = (step) => {
|
||||||
|
permits.push({ token: null, amount: null, spender: null, step });
|
||||||
|
stepsUnread.push(step);
|
||||||
|
};
|
||||||
|
|
||||||
// Who the steps pay, in whichever step and of whatever token.
|
// Who the steps pay, in whichever step and of whatever token.
|
||||||
// MSG_SENDER is the sender. The router itself, as ADDRESS_THIS or by
|
// MSG_SENDER is the sender. The router itself, as ADDRESS_THIS or by
|
||||||
@@ -1405,6 +1475,14 @@ function decode(data, toAddress, chainId, sources, fromAddress) {
|
|||||||
v2PairFor(chainId, next.path[0], next.path[1]).toLowerCase()
|
v2PairFor(chainId, next.path[0], next.path[1]).toLowerCase()
|
||||||
);
|
);
|
||||||
};
|
};
|
||||||
|
// Whether a SWEEP, TRANSFER, PAY_PORTION or PAY_PORTION_FULL_PRECISION
|
||||||
|
// of `token` to `recipient` pays anyone WETH (see lastWethStep): it
|
||||||
|
// does when `token` is WETH, and when it pays ETH to a WETH contract,
|
||||||
|
// which pays the router WETH for it.
|
||||||
|
const paysWeth = (token, recipient) =>
|
||||||
|
WETH_ADDRESSES.includes(token.toLowerCase()) ||
|
||||||
|
(token === "0x0000000000000000000000000000000000000000" &&
|
||||||
|
WETH_ADDRESSES.includes(recipient.toLowerCase()));
|
||||||
|
|
||||||
for (let i = 0; i < commandsBytes.length; i++) {
|
for (let i = 0; i < commandsBytes.length; i++) {
|
||||||
const cmdId = commandsBytes[i] & commandTypeMask;
|
const cmdId = commandsBytes[i] & commandTypeMask;
|
||||||
@@ -1421,6 +1499,9 @@ function decode(data, toAddress, chainId, sources, fromAddress) {
|
|||||||
? COMMAND_NAMES[command]
|
? COMMAND_NAMES[command]
|
||||||
: "Command 0x" + cmdId.toString(16).padStart(2, "0"),
|
: "Command 0x" + cmdId.toString(16).padStart(2, "0"),
|
||||||
);
|
);
|
||||||
|
// Set by a branch below that reads a step that cannot take WETH
|
||||||
|
// out of the router or pay anyone WETH (see lastWethStep).
|
||||||
|
let keepsRouterWeth = false;
|
||||||
|
|
||||||
try {
|
try {
|
||||||
if (command === "EXECUTE_SUB_PLAN") {
|
if (command === "EXECUTE_SUB_PLAN") {
|
||||||
@@ -1437,23 +1518,44 @@ function decode(data, toAddress, chainId, sources, fromAddress) {
|
|||||||
} else if (command === "PERMIT2_PERMIT") {
|
} else if (command === "PERMIT2_PERMIT") {
|
||||||
const p = decodePermit2(inputs[i]);
|
const p = decodePermit2(inputs[i]);
|
||||||
if (p) {
|
if (p) {
|
||||||
|
permits.push({ ...p, step: i });
|
||||||
|
keepsRouterWeth = true;
|
||||||
|
} else {
|
||||||
|
permitUnread(i);
|
||||||
|
}
|
||||||
|
// Only a permit whose amount stands as the Amount figure
|
||||||
|
// names Token In (see permitStands). Every other permit,
|
||||||
|
// before the step that sets the input side or after it,
|
||||||
|
// leaves Token In and Amount as they read with no permit
|
||||||
|
// and gets lines of its own. One after a step set the input
|
||||||
|
// side never stands, so only one before it is kept here.
|
||||||
|
if (p && !inputEstablished) {
|
||||||
// Whether a step before it took its token, or may
|
// Whether a step before it took its token, or may
|
||||||
// have: the step that set the input side or one in
|
// have: one in `userPaid`, `movedIntoRouter` or
|
||||||
// `userPaid`, when its token is the permit's or not
|
// `movedFromSender`, when its token is the permit's
|
||||||
// known.
|
// or not known. No step has set the input side yet.
|
||||||
const mayBeItsToken = (token) =>
|
const mayBeItsToken = (token) =>
|
||||||
!present(token) || sameAddress(token, p.token);
|
!present(token) || sameAddress(token, p.token);
|
||||||
const tookBefore =
|
const tookBefore = [
|
||||||
(inputEstablished && mayBeItsToken(inputToken)) ||
|
...userPaid,
|
||||||
userPaid.some((t) => mayBeItsToken(t.token));
|
...movedIntoRouter,
|
||||||
|
...movedFromSender,
|
||||||
|
].some((t) => mayBeItsToken(t.token));
|
||||||
permit = {
|
permit = {
|
||||||
...p,
|
...p,
|
||||||
step: i,
|
step: i,
|
||||||
allowedToFail,
|
allowedToFail,
|
||||||
beforeEveryTake: !tookBefore,
|
beforeEveryTake: !tookBefore,
|
||||||
};
|
};
|
||||||
|
}
|
||||||
|
} else if (command === "PERMIT2_PERMIT_BATCH") {
|
||||||
|
// Each allowance it grants gets the lines of a permit
|
||||||
|
// whose amount does not stand. It pays nobody.
|
||||||
|
const batch = decodePermit2Batch(inputs[i]);
|
||||||
|
if (batch) {
|
||||||
|
permits.push(...batch.map((p) => ({ ...p, step: i })));
|
||||||
} else {
|
} else {
|
||||||
stepsUnread.push(i);
|
permitUnread(i);
|
||||||
}
|
}
|
||||||
} else if (command === "PERMIT2_TRANSFER_FROM") {
|
} else if (command === "PERMIT2_TRANSFER_FROM") {
|
||||||
const p = decodePermit2TransferFrom(inputs[i]);
|
const p = decodePermit2TransferFrom(inputs[i]);
|
||||||
@@ -1507,6 +1609,7 @@ function decode(data, toAddress, chainId, sources, fromAddress) {
|
|||||||
// what the user receives: it sets no side, and the
|
// what the user receives: it sets no side, and the
|
||||||
// step says so.
|
// step says so.
|
||||||
commandNames[i] += " (of another address)";
|
commandNames[i] += " (of another address)";
|
||||||
|
keepsRouterWeth = true;
|
||||||
} 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
|
||||||
@@ -1517,21 +1620,23 @@ function decode(data, toAddress, chainId, sources, fromAddress) {
|
|||||||
// does. It pays nobody.
|
// does. It pays nobody.
|
||||||
const minBalance = allowedToFail ? 0n : b.minBalance;
|
const minBalance = allowedToFail ? 0n : b.minBalance;
|
||||||
if (!(minBalance === 0n && present(minOutput))) {
|
if (!(minBalance === 0n && present(minOutput))) {
|
||||||
setOutput(b.token, minBalance, []);
|
setOutput(i, b.token, minBalance, []);
|
||||||
}
|
}
|
||||||
|
keepsRouterWeth = true;
|
||||||
}
|
}
|
||||||
} else if (command === "V3_SWAP_EXACT_IN") {
|
} else if (command === "V3_SWAP_EXACT_IN") {
|
||||||
const s = decodeV3SwapExactIn(inputs[i]);
|
const s = decodeV3SwapExactIn(inputs[i]);
|
||||||
if (s) {
|
if (s) {
|
||||||
if (!inputEstablished) {
|
if (!inputEstablished) {
|
||||||
setInputOnce(s.tokenIn, s.amountIn);
|
setInputOnce(s.tokenIn, s.amountIn);
|
||||||
|
inputPaidByUser = s.payerIsUser;
|
||||||
} else if (s.payerIsUser) {
|
} else if (s.payerIsUser) {
|
||||||
addUserPaid(s.tokenIn, s.amountIn);
|
addUserPaid(s.tokenIn, s.amountIn);
|
||||||
}
|
}
|
||||||
// Always update output: in multi-step swaps (V3 → V4),
|
// Always update output: in multi-step swaps (V3 → V4),
|
||||||
// the last swap step determines the final output token
|
// the last swap step determines the final output token
|
||||||
// and minimum received amount.
|
// and minimum received amount.
|
||||||
setOutput(s.tokenOut, s.amountOutMin, [s.recipient]);
|
setOutput(i, s.tokenOut, s.amountOutMin, [s.recipient]);
|
||||||
if (!s.payerIsUser) {
|
if (!s.payerIsUser) {
|
||||||
spendFromRouter(s.tokenIn, s.amountIn);
|
spendFromRouter(s.tokenIn, s.amountIn);
|
||||||
}
|
}
|
||||||
@@ -1548,10 +1653,11 @@ function decode(data, toAddress, chainId, sources, fromAddress) {
|
|||||||
if (s) {
|
if (s) {
|
||||||
if (!inputEstablished) {
|
if (!inputEstablished) {
|
||||||
setInputOnce(s.tokenIn, s.amountIn);
|
setInputOnce(s.tokenIn, s.amountIn);
|
||||||
|
inputPaidByUser = s.payerIsUser;
|
||||||
} else if (s.payerIsUser) {
|
} else if (s.payerIsUser) {
|
||||||
addUserPaid(s.tokenIn, s.amountIn);
|
addUserPaid(s.tokenIn, s.amountIn);
|
||||||
}
|
}
|
||||||
setOutput(s.tokenOut, s.amountOutMin, [s.recipient]);
|
setOutput(i, s.tokenOut, s.amountOutMin, [s.recipient]);
|
||||||
if (!s.payerIsUser) {
|
if (!s.payerIsUser) {
|
||||||
spendFromRouter(s.tokenIn, s.amountIn);
|
spendFromRouter(s.tokenIn, s.amountIn);
|
||||||
}
|
}
|
||||||
@@ -1579,10 +1685,11 @@ function decode(data, toAddress, chainId, sources, fromAddress) {
|
|||||||
if (s) {
|
if (s) {
|
||||||
if (!inputEstablished) {
|
if (!inputEstablished) {
|
||||||
setInputOnce(s.tokenIn, s.amountInMax);
|
setInputOnce(s.tokenIn, s.amountInMax);
|
||||||
|
inputPaidByUser = s.payerIsUser;
|
||||||
} else if (s.payerIsUser) {
|
} else if (s.payerIsUser) {
|
||||||
addUserPaid(s.tokenIn, s.amountInMax);
|
addUserPaid(s.tokenIn, s.amountInMax);
|
||||||
}
|
}
|
||||||
setOutput(s.tokenOut, s.amountOut, [s.recipient]);
|
setOutput(i, s.tokenOut, s.amountOut, [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);
|
||||||
}
|
}
|
||||||
@@ -1604,6 +1711,7 @@ function decode(data, toAddress, chainId, sources, fromAddress) {
|
|||||||
if (!isRouter(s.recipient)) {
|
if (!isRouter(s.recipient)) {
|
||||||
heldByRouter.delete(s.token.toLowerCase());
|
heldByRouter.delete(s.token.toLowerCase());
|
||||||
}
|
}
|
||||||
|
keepsRouterWeth = !paysWeth(s.token, s.recipient);
|
||||||
} else {
|
} else {
|
||||||
payeeUnread = true;
|
payeeUnread = true;
|
||||||
stepsUnread.push(i);
|
stepsUnread.push(i);
|
||||||
@@ -1641,6 +1749,7 @@ function decode(data, toAddress, chainId, sources, fromAddress) {
|
|||||||
) {
|
) {
|
||||||
heldByRouter.delete(t.token.toLowerCase());
|
heldByRouter.delete(t.token.toLowerCase());
|
||||||
}
|
}
|
||||||
|
keepsRouterWeth = !paysWeth(t.token, t.recipient);
|
||||||
} else {
|
} else {
|
||||||
payeeUnread = true;
|
payeeUnread = true;
|
||||||
stepsUnread.push(i);
|
stepsUnread.push(i);
|
||||||
@@ -1672,10 +1781,13 @@ function decode(data, toAddress, chainId, sources, fromAddress) {
|
|||||||
} else if (command === "WRAP_ETH") {
|
} else if (command === "WRAP_ETH") {
|
||||||
const w = decodeWrapEth(inputs[i]);
|
const w = decodeWrapEth(inputs[i]);
|
||||||
if (w) {
|
if (w) {
|
||||||
setInputOnce(
|
if (!inputEstablished) {
|
||||||
"0x0000000000000000000000000000000000000000",
|
setInputOnce(
|
||||||
w.amount,
|
"0x0000000000000000000000000000000000000000",
|
||||||
);
|
w.amount,
|
||||||
|
);
|
||||||
|
inputPaidByUser = true;
|
||||||
|
}
|
||||||
addPayee(w.recipient);
|
addPayee(w.recipient);
|
||||||
// CONTRACT_BALANCE wraps all the router's ETH.
|
// CONTRACT_BALANCE wraps all the router's ETH.
|
||||||
if (w.amount === CONTRACT_BALANCE) {
|
if (w.amount === CONTRACT_BALANCE) {
|
||||||
@@ -1765,14 +1877,21 @@ function decode(data, toAddress, chainId, sources, fromAddress) {
|
|||||||
minOutput = v4.amountOutMin;
|
minOutput = v4.amountOutMin;
|
||||||
outputEstablished = true;
|
outputEstablished = true;
|
||||||
outputUnwrapped = false;
|
outputUnwrapped = false;
|
||||||
|
unwrapIntoRouterStep = null;
|
||||||
outputRecipients = takeRecipients;
|
outputRecipients = takeRecipients;
|
||||||
|
outputStep = i;
|
||||||
} else if (v4) {
|
} else if (v4) {
|
||||||
// A step with no swap action sets only the sides its
|
// A step with no swap action sets only the sides its
|
||||||
// SETTLE, SETTLE_ALL, TAKE or TAKE_ALL names:
|
// SETTLE, SETTLE_ALL, TAKE or TAKE_ALL names:
|
||||||
// setInputOnce() and setOutput() leave alone a side
|
// setInputOnce() and setOutput() leave alone a side
|
||||||
// whose two halves are both unstated.
|
// whose two halves are both unstated.
|
||||||
setInputOnce(v4.tokenIn, amountIn);
|
setInputOnce(v4.tokenIn, amountIn);
|
||||||
setOutput(v4.tokenOut, v4.amountOutMin, takeRecipients);
|
setOutput(
|
||||||
|
i,
|
||||||
|
v4.tokenOut,
|
||||||
|
v4.amountOutMin,
|
||||||
|
takeRecipients,
|
||||||
|
);
|
||||||
}
|
}
|
||||||
// Every V4 step, with a swap action or without, takes
|
// Every V4 step, with a swap action or without, takes
|
||||||
// from the sender what the user pays it (an amount an
|
// from the sender what the user pays it (an amount an
|
||||||
@@ -1799,12 +1918,17 @@ function decode(data, toAddress, chainId, sources, fromAddress) {
|
|||||||
// among it when the step that set the output side paid it
|
// among it when the step that set the output side paid it
|
||||||
// to the router and the router still holds WETH. WETH
|
// to the router and the router still holds WETH. WETH
|
||||||
// that step paid to the user, or to anyone else, stays
|
// that step paid to the user, or to anyone else, stays
|
||||||
// WETH, so when that step also paid some of its output
|
// WETH. When that step also paid some of its output
|
||||||
// elsewhere, or made a payout this decoder did not read,
|
// elsewhere or made a payout this decoder did not read,
|
||||||
// only part of it may be unwrapped. This decoder does not
|
// or this decoder treats a step between the two as one
|
||||||
// count how much of that step's minimum then reaches the
|
// that may take WETH out of the router or pay anyone WETH
|
||||||
// router, nor read the UNWRAP_WETH's own minimum, so the
|
// (see lastWethStep), the WETH unwrapped may be only part
|
||||||
// output side keeps no figure.
|
// of the output side's, or none of it.
|
||||||
|
// This decoder does not count how much of that step's
|
||||||
|
// minimum then reaches the UNWRAP_WETH, nor read the
|
||||||
|
// UNWRAP_WETH's own minimum, so the output side keeps no
|
||||||
|
// figure.
|
||||||
|
const u = decodeUnwrapWeth(inputs[i]);
|
||||||
const toRouter = (r) => present(r) && isRouter(r);
|
const toRouter = (r) => present(r) && isRouter(r);
|
||||||
if (
|
if (
|
||||||
present(outputToken) &&
|
present(outputToken) &&
|
||||||
@@ -1813,11 +1937,19 @@ function decode(data, toAddress, chainId, sources, fromAddress) {
|
|||||||
outputRecipients.some(toRouter)
|
outputRecipients.some(toRouter)
|
||||||
) {
|
) {
|
||||||
outputUnwrapped = true;
|
outputUnwrapped = true;
|
||||||
if (!outputRecipients.every(toRouter)) {
|
if (
|
||||||
|
unwrapIntoRouterStep === null &&
|
||||||
|
(u === null || isRouter(u.recipient))
|
||||||
|
) {
|
||||||
|
unwrapIntoRouterStep = i;
|
||||||
|
}
|
||||||
|
if (
|
||||||
|
!outputRecipients.every(toRouter) ||
|
||||||
|
lastWethStep > outputStep
|
||||||
|
) {
|
||||||
minOutput = null;
|
minOutput = null;
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
const u = decodeUnwrapWeth(inputs[i]);
|
|
||||||
if (u) {
|
if (u) {
|
||||||
addPayee(u.recipient);
|
addPayee(u.recipient);
|
||||||
// It pays out all the router's WETH, as ETH. Into the
|
// It pays out all the router's WETH, as ETH. Into the
|
||||||
@@ -1839,8 +1971,8 @@ function decode(data, toAddress, chainId, sources, fromAddress) {
|
|||||||
}
|
}
|
||||||
} else {
|
} else {
|
||||||
// Any other step may pay an address this decoder does not
|
// Any other step may pay an address this decoder does not
|
||||||
// read: PERMIT2_PERMIT_BATCH and the NFT commands among
|
// read: the NFT commands among them, and a type the
|
||||||
// them, and a type the release names no command for.
|
// release names no command for.
|
||||||
payeeUnread = true;
|
payeeUnread = true;
|
||||||
stepsUnread.push(i);
|
stepsUnread.push(i);
|
||||||
}
|
}
|
||||||
@@ -1854,6 +1986,26 @@ function decode(data, toAddress, chainId, sources, fromAddress) {
|
|||||||
if (allowedToFail) {
|
if (allowedToFail) {
|
||||||
commandNames[i] += " (allowed to fail)";
|
commandNames[i] += " (allowed to fail)";
|
||||||
}
|
}
|
||||||
|
if (!keepsRouterWeth) {
|
||||||
|
lastWethStep = i;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// After an UNWRAP_WETH that may have paid the output side's WETH to
|
||||||
|
// the router as ETH, a later step may pay that ETH out as WETH, as a
|
||||||
|
// WRAP_ETH of it to the user does. This decoder treats every later
|
||||||
|
// step but those lastWethStep names as one that may, and does not
|
||||||
|
// count how much of that ETH each pays out: after one, the output
|
||||||
|
// side reads as WETH with no figure. Neither this nor the loss of the
|
||||||
|
// figure in the UNWRAP_WETH branch is undone by any later step, a
|
||||||
|
// later UNWRAP_WETH included, but one that sets the output side again.
|
||||||
|
if (
|
||||||
|
outputUnwrapped &&
|
||||||
|
unwrapIntoRouterStep !== null &&
|
||||||
|
lastWethStep > unwrapIntoRouterStep
|
||||||
|
) {
|
||||||
|
outputUnwrapped = false;
|
||||||
|
minOutput = null;
|
||||||
}
|
}
|
||||||
|
|
||||||
// The Amount line, and the lines for what the steps take beyond it.
|
// The Amount line, and the lines for what the steps take beyond it.
|
||||||
@@ -1866,18 +2018,26 @@ function decode(data, toAddress, chainId, sources, fromAddress) {
|
|||||||
// lines of its own. One whose amount is not known also leaves the
|
// lines of its own. One whose amount is not known also leaves the
|
||||||
// total unknown, with no figure.
|
// total unknown, with no figure.
|
||||||
//
|
//
|
||||||
// The last PERMIT2_PERMIT read names Token In. Its amount stands as
|
// A PERMIT2_PERMIT names Token In only when its amount stands as the
|
||||||
// the Amount figure in place of the total only in the plain shape of
|
// Amount figure in place of the total, which it does only in the
|
||||||
// Uniswap's own routes: it is the only PERMIT2_PERMIT, its spender is
|
// plain shape of Uniswap's own routes: it comes before the step that
|
||||||
|
// set the input side, it is the only PERMIT2_PERMIT in the
|
||||||
|
// transaction and there is no PERMIT2_PERMIT_BATCH, its spender is
|
||||||
// the router, the router may not let it fail, no step before it took
|
// the router, the router may not let it fail, no step before it took
|
||||||
// its token or one not known, and this decoder read every step after
|
// its token or one not known (a PERMIT2_TRANSFER_FROM of its token
|
||||||
// it in full (see stepsUnread). Permit2 then lets the router take no
|
// included), and this decoder read every step after it in full (see
|
||||||
// more of the token than that amount, so the permit covers every take
|
// stepsUnread). Permit2 then lets the router take no more of the token
|
||||||
// of it. A later step this decoder did not read may raise what Permit2
|
// than that amount, so the permit covers every take of it. A step
|
||||||
// lets the router take, as a PERMIT2_PERMIT_BATCH can. A step that
|
// before it takes under whatever allowance the router already had, so
|
||||||
// may take from the sender what this decoder did not read leaves no
|
// it may take more. A later permit or batch, or a later step this
|
||||||
// figure, permit or not (see spentUnread()), and an EXECUTE_SUB_PLAN
|
// decoder did not read, may raise what Permit2 lets the router take.
|
||||||
// step leaves both sides unknown (below).
|
// 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
|
||||||
|
// that may take from the sender what this decoder did not read leaves
|
||||||
|
// no figure, permit or not (see spentUnread()), and so do a permit
|
||||||
|
// or batch whose input it 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],
|
||||||
@@ -1885,6 +2045,7 @@ function decode(data, toAddress, chainId, sources, fromAddress) {
|
|||||||
const permitStands =
|
const permitStands =
|
||||||
permit !== null &&
|
permit !== null &&
|
||||||
stepCommands.filter((c) => c === "PERMIT2_PERMIT").length === 1 &&
|
stepCommands.filter((c) => c === "PERMIT2_PERMIT").length === 1 &&
|
||||||
|
!stepCommands.includes("PERMIT2_PERMIT_BATCH") &&
|
||||||
sameAddress(permit.spender, toAddress) &&
|
sameAddress(permit.spender, toAddress) &&
|
||||||
!permit.allowedToFail &&
|
!permit.allowedToFail &&
|
||||||
permit.beforeEveryTake &&
|
permit.beforeEveryTake &&
|
||||||
@@ -1894,6 +2055,11 @@ function decode(data, toAddress, chainId, sources, fromAddress) {
|
|||||||
// (see spentUnread()), or a token it does not know.
|
// (see spentUnread()), or a token it does not know.
|
||||||
const spentFromSender = [];
|
const spentFromSender = [];
|
||||||
let total = null;
|
let total = null;
|
||||||
|
// 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
|
||||||
|
// its own (see below). The amount of a step that set the input side
|
||||||
|
// and is paid from the router counts in `total` but is not among them.
|
||||||
|
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
|
||||||
@@ -1904,17 +2070,20 @@ function decode(data, toAddress, chainId, sources, fromAddress) {
|
|||||||
// 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
|
||||||
// starts from it and it stated no amount (see below), or null.
|
// starts from it and it stated no amount (see below), or null.
|
||||||
let firstTakeUnstated = null;
|
let firstTakeUnstated = null;
|
||||||
if (permit === null || sameAddress(inputToken, permit.token)) {
|
if (!permitStands || sameAddress(inputToken, permit.token)) {
|
||||||
total = inputAmount;
|
total = inputAmount;
|
||||||
|
if (typeof inputAmount === "bigint" && inputPaidByUser) {
|
||||||
|
inTotal.push({ token: inputToken, amount: inputAmount });
|
||||||
|
}
|
||||||
if (hasFirstTake && !present(inputAmount)) {
|
if (hasFirstTake && !present(inputAmount)) {
|
||||||
firstTakeUnstated = { token: inputToken, amount: null };
|
firstTakeUnstated = { token: inputToken, amount: null };
|
||||||
}
|
}
|
||||||
} else if (hasFirstTake) {
|
} else if (hasFirstTake) {
|
||||||
// The step that set the input side spent a token other than the
|
// The step that set the input side spent a token other than the
|
||||||
// permit's, or one not known, so the total starts with no figure.
|
// permit's, or one not known, so its amount gets lines of its own.
|
||||||
spentFromSender.push({ token: inputToken, amount: inputAmount });
|
spentFromSender.push({ token: inputToken, amount: inputAmount });
|
||||||
}
|
}
|
||||||
if (permit !== null) inputToken = permit.token;
|
if (permitStands) inputToken = permit.token;
|
||||||
for (const t of userPaid) {
|
for (const t of userPaid) {
|
||||||
const ofTokenIn = sameAddress(t.token, inputToken);
|
const ofTokenIn = sameAddress(t.token, inputToken);
|
||||||
if (ofTokenIn && permitStands) continue;
|
if (ofTokenIn && permitStands) continue;
|
||||||
@@ -1924,6 +2093,7 @@ function decode(data, toAddress, chainId, sources, fromAddress) {
|
|||||||
typeof t.amount === "bigint"
|
typeof t.amount === "bigint"
|
||||||
) {
|
) {
|
||||||
total += t.amount;
|
total += t.amount;
|
||||||
|
inTotal.push(t);
|
||||||
continue;
|
continue;
|
||||||
}
|
}
|
||||||
spentFromSender.push(t);
|
spentFromSender.push(t);
|
||||||
@@ -1947,10 +2117,9 @@ function decode(data, toAddress, chainId, sources, fromAddress) {
|
|||||||
}
|
}
|
||||||
|
|
||||||
// The commands of an EXECUTE_SUB_PLAN step may spend the user's tokens
|
// The commands of an EXECUTE_SUB_PLAN step may spend the user's tokens
|
||||||
// or pay the user, before or after any other step, and a permit among
|
// or pay the user, before or after any other step. What the other
|
||||||
// them would name Token In. What the other steps state is
|
// steps state is then not the whole swap, so both sides are set
|
||||||
// then not the whole swap, so both sides are set unknown, with no
|
// unknown, with no figure, wherever the step stands.
|
||||||
// figure, wherever the step stands.
|
|
||||||
if (hasSubPlan) {
|
if (hasSubPlan) {
|
||||||
inputToken = null;
|
inputToken = null;
|
||||||
inputAmount = null;
|
inputAmount = null;
|
||||||
@@ -2053,12 +2222,30 @@ function decode(data, toAddress, chainId, sources, fromAddress) {
|
|||||||
return amountText(amount, info);
|
return amountText(amount, info);
|
||||||
};
|
};
|
||||||
|
|
||||||
|
// Each allowance to a spender other than the router. Code that a step
|
||||||
|
// runs, such as a V4 pool's hook or a token's own code, can call that
|
||||||
|
// spender, which can then take up to the allowance from the sender
|
||||||
|
// before the transaction ends. A permit or batch this decoder could
|
||||||
|
// not read may be to any spender, of any token.
|
||||||
|
const toAnotherSpender = permits.filter(
|
||||||
|
(p) => !sameAddress(p.spender, toAddress),
|
||||||
|
);
|
||||||
|
|
||||||
// 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, leaves no Amount figure, which may
|
// or a token it does not know, and an allowance to another spender
|
||||||
// then be too low.
|
// 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
|
||||||
|
// 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(
|
||||||
|
(p) =>
|
||||||
|
present(p.token) &&
|
||||||
|
present(inputToken) &&
|
||||||
|
!sameAddress(p.token, inputToken),
|
||||||
|
)
|
||||||
) {
|
) {
|
||||||
const amount = spentText(inputAmount, inInfo);
|
const amount = spentText(inputAmount, inInfo);
|
||||||
details.push({
|
details.push({
|
||||||
@@ -2066,6 +2253,8 @@ function decode(data, toAddress, chainId, sources, fromAddress) {
|
|||||||
value: amount.display,
|
value: amount.display,
|
||||||
rawValue: amount.raw,
|
rawValue: amount.raw,
|
||||||
});
|
});
|
||||||
|
} else {
|
||||||
|
spentFromSender.unshift(...inTotal);
|
||||||
}
|
}
|
||||||
|
|
||||||
// What steps take from the sender beyond the Amount line, in the shape
|
// What steps take from the sender beyond the Amount line, in the shape
|
||||||
@@ -2108,6 +2297,40 @@ function decode(data, toAddress, chainId, sources, fromAddress) {
|
|||||||
);
|
);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// What each allowance of a PERMIT2_PERMIT or PERMIT2_PERMIT_BATCH lets
|
||||||
|
// its spender take: its amount, its token and the spender, an address
|
||||||
|
// on a line of its own. Permit2's maximum is unbounded. Only a permit
|
||||||
|
// whose amount stands as the Amount figure (see permitStands) gets
|
||||||
|
// none: that line already gives its amount and Token In its token,
|
||||||
|
// and its spender is the router. Every other allowance, one after the
|
||||||
|
// step that set the input side included, gets these lines, so nothing
|
||||||
|
// it lets anyone take goes unstated. A permit or batch this decoder
|
||||||
|
// could not read gets one line saying so.
|
||||||
|
for (const p of permits) {
|
||||||
|
if (permitStands && p.step === permit.step) continue;
|
||||||
|
if (!present(p.token)) {
|
||||||
|
details.push({
|
||||||
|
label: "Permit2 allowance",
|
||||||
|
value: UNDECODED_CURRENCY,
|
||||||
|
});
|
||||||
|
continue;
|
||||||
|
}
|
||||||
|
details.push({
|
||||||
|
label: "Permit2 allowance",
|
||||||
|
value:
|
||||||
|
p.amount >= MAX_UINT160
|
||||||
|
? "Unlimited"
|
||||||
|
: amountText(p.amount, tokenInfo(p.token, sources))
|
||||||
|
.display,
|
||||||
|
});
|
||||||
|
details.push(tokenMovedLine("Allowance token", p.token, sources));
|
||||||
|
details.push({
|
||||||
|
label: "Allowance spender",
|
||||||
|
value: p.spender,
|
||||||
|
address: p.spender,
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
// Keyed on the address, not the symbol: a token absent from the
|
// Keyed on the address, not the symbol: a token absent from the
|
||||||
// bundled list has no symbol, and gating the line on one dropped it
|
// bundled list has no symbol, and gating the line on one dropped it
|
||||||
// entirely, leaving a Min. received figure with nothing saying what is
|
// entirely, leaving a Min. received figure with nothing saying what is
|
||||||
@@ -2143,9 +2366,10 @@ function decode(data, toAddress, chainId, sources, fromAddress) {
|
|||||||
// step pays the bridge, when one moves the sender's tokens into the
|
// step pays the bridge, when one moves the sender's tokens into the
|
||||||
// router, when a token stays in the router, and when a payout could
|
// router, when a token stays in the router, and when a payout could
|
||||||
// not be read. The output is received by the sender only when some
|
// not be read. The output is received by the sender only when some
|
||||||
// step pays the sender and there is no such line. When no step names
|
// step pays the sender, there is no such line, and no allowance goes
|
||||||
// anyone paid, one line says so. `paidTo` holds these lines and the
|
// to another spender (see toAnotherSpender). When no step names anyone
|
||||||
// token line after each line about a token in the router.
|
// paid, one line says so. `paidTo` holds these lines and the token
|
||||||
|
// line after each line about a token in the router.
|
||||||
const outputHeld =
|
const outputHeld =
|
||||||
present(outputToken) && heldByRouter.has(outputToken.toLowerCase());
|
present(outputToken) && heldByRouter.has(outputToken.toLowerCase());
|
||||||
const paidTo = paidElsewhere.map((address) => ({
|
const paidTo = paidElsewhere.map((address) => ({
|
||||||
@@ -2192,7 +2416,10 @@ function decode(data, toAddress, chainId, sources, fromAddress) {
|
|||||||
if (payeeUnread) {
|
if (payeeUnread) {
|
||||||
paidTo.push({ label: "Paid to", value: UNDECODED_CURRENCY });
|
paidTo.push({ label: "Paid to", value: UNDECODED_CURRENCY });
|
||||||
}
|
}
|
||||||
const received = paidToSender && paidTo.length === 0;
|
const received =
|
||||||
|
paidToSender &&
|
||||||
|
paidTo.length === 0 &&
|
||||||
|
toAnotherSpender.length === 0;
|
||||||
if (!paidToSender && paidTo.length === 0) {
|
if (!paidToSender && paidTo.length === 0) {
|
||||||
paidTo.push({ label: "Paid to", value: UNNAMED_CURRENCY });
|
paidTo.push({ label: "Paid to", value: UNNAMED_CURRENCY });
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -19,7 +19,10 @@
|
|||||||
// that followed persisted the pre-refresh values — while still stamping
|
// that followed persisted the pre-refresh values — while still stamping
|
||||||
// lastBalanceRefresh, suppressing the redo.
|
// lastBalanceRefresh, suppressing the redo.
|
||||||
//
|
//
|
||||||
// Both use the real persistence path over a cloning storage stub. Nothing here
|
// A network switch landing inside a balance refresh's round trip is covered at
|
||||||
|
// the end (https://git.eeqj.de/sneak/AutistMask/issues/577).
|
||||||
|
//
|
||||||
|
// All use the real persistence path over a cloning storage stub. Nothing here
|
||||||
// asserts the absence of a loadState() call; each asserts the OUTCOME, so it
|
// asserts the absence of a loadState() call; each asserts the OUTCOME, so it
|
||||||
// holds against any implementation that gets the outcome right.
|
// holds against any implementation that gets the outcome right.
|
||||||
|
|
||||||
@@ -395,3 +398,48 @@ describe("a balance refresh under another handler's state read", () => {
|
|||||||
expect(after.wallets[0].addresses[0].balance).toBe(REFRESHED_BALANCE);
|
expect(after.wallets[0].addresses[0].balance).toBe(REFRESHED_BALANCE);
|
||||||
});
|
});
|
||||||
});
|
});
|
||||||
|
|
||||||
|
describe("a balance refresh under a network switch", () => {
|
||||||
|
// https://git.eeqj.de/sneak/AutistMask/issues/577. The switch clears every
|
||||||
|
// address's balances, and a refresh that started on the previous network
|
||||||
|
// must not write that network's back over them when it returns. The same
|
||||||
|
// refresh in the popup is in tests/balanceRefreshNetworkSwitch.test.js.
|
||||||
|
test("a refresh that returns after a switch writes nothing, and the next one runs on the new network", async () => {
|
||||||
|
const roundTrip = deferred();
|
||||||
|
const reachedNetwork = deferred();
|
||||||
|
const ranOn = [];
|
||||||
|
|
||||||
|
const bg = loadWorker("sepolia", {
|
||||||
|
refreshBalances: async (wallets, rpcUrl, explorer, tokens, id) => {
|
||||||
|
ranOn.push(id);
|
||||||
|
reachedNetwork.resolve();
|
||||||
|
await roundTrip.promise;
|
||||||
|
wallets[0].addresses[0].balance = REFRESHED_BALANCE;
|
||||||
|
},
|
||||||
|
});
|
||||||
|
|
||||||
|
const refresh = bg.fireBalanceAlarm();
|
||||||
|
await reachedNetwork.promise;
|
||||||
|
|
||||||
|
// The user switches to Ethereum Mainnet in Settings while the round
|
||||||
|
// trip is out.
|
||||||
|
const during = bg.persisted();
|
||||||
|
applyChainSwitchFields(during, MAINNET.id);
|
||||||
|
global.chrome.storage.write("autistmask", during);
|
||||||
|
|
||||||
|
roundTrip.resolve();
|
||||||
|
await refresh;
|
||||||
|
|
||||||
|
const after = bg.persisted();
|
||||||
|
expect(after.networkId).toBe("mainnet");
|
||||||
|
expect(after.wallets[0].addresses[0].balance).toBe("0");
|
||||||
|
expect(after.lastBalanceRefresh).toBe(0);
|
||||||
|
|
||||||
|
await bg.fireBalanceAlarm();
|
||||||
|
|
||||||
|
expect(ranOn).toEqual(["sepolia", "mainnet"]);
|
||||||
|
expect(bg.persisted().wallets[0].addresses[0].balance).toBe(
|
||||||
|
REFRESHED_BALANCE,
|
||||||
|
);
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|||||||
@@ -18,6 +18,11 @@ const {
|
|||||||
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";
|
||||||
const ADDRESS = "0x1111111111111111111111111111111111111111";
|
const ADDRESS = "0x1111111111111111111111111111111111111111";
|
||||||
|
const TRACKED = {
|
||||||
|
address: "0x7777777777777777777777777777777777777777",
|
||||||
|
symbol: "TRK",
|
||||||
|
decimals: 6,
|
||||||
|
};
|
||||||
|
|
||||||
const realFetch = globalThis.fetch;
|
const realFetch = globalThis.fetch;
|
||||||
let logged;
|
let logged;
|
||||||
@@ -30,9 +35,9 @@ beforeEach(() => {
|
|||||||
const failedToFetch = async () => {
|
const failedToFetch = async () => {
|
||||||
throw new TypeError("Failed to fetch");
|
throw new TypeError("Failed to fetch");
|
||||||
};
|
};
|
||||||
// The RPC calls (ETH balance, ENS name, and the scan's balance and
|
// The RPC calls (ETH balance, ENS name, the tracked token's balance, and
|
||||||
// transaction count) and the explorer request (token balances) all fail
|
// the scan's balance and transaction count) and the explorer request (the
|
||||||
// the same way.
|
// other token balances) all fail the same way.
|
||||||
FetchRequest.registerGetUrl(failedToFetch);
|
FetchRequest.registerGetUrl(failedToFetch);
|
||||||
globalThis.fetch = jest.fn(failedToFetch);
|
globalThis.fetch = jest.fn(failedToFetch);
|
||||||
});
|
});
|
||||||
@@ -49,7 +54,7 @@ function refresh(signal) {
|
|||||||
wallets,
|
wallets,
|
||||||
RPC_URL,
|
RPC_URL,
|
||||||
EXPLORER_URL,
|
EXPLORER_URL,
|
||||||
[],
|
[TRACKED],
|
||||||
"mainnet",
|
"mainnet",
|
||||||
signal,
|
signal,
|
||||||
);
|
);
|
||||||
@@ -60,6 +65,7 @@ test("a failure while the popup is open is reported", async () => {
|
|||||||
for (const label of [
|
for (const label of [
|
||||||
"ETH balance failed",
|
"ETH balance failed",
|
||||||
"ENS reverse failed",
|
"ENS reverse failed",
|
||||||
|
"token balance failed",
|
||||||
"fetchTokenBalances failed: Failed to fetch",
|
"fetchTokenBalances failed: Failed to fetch",
|
||||||
]) {
|
]) {
|
||||||
expect(logged.some((line) => line.includes(label))).toBe(true);
|
expect(logged.some((line) => line.includes(label))).toBe(true);
|
||||||
|
|||||||
@@ -0,0 +1,161 @@
|
|||||||
|
// A balance refresh the popup started on one network, and that returns after
|
||||||
|
// the network was switched to another, writes nothing: the switch cleared every
|
||||||
|
// address's balances, and the previous network's must not come back over them
|
||||||
|
// (https://git.eeqj.de/sneak/AutistMask/issues/577). The switch is made either
|
||||||
|
// by the user in this popup's Settings, or by the background after the user
|
||||||
|
// 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
|
||||||
|
// refresh in the background is in tests/backgroundStateIsolation.test.js.
|
||||||
|
|
||||||
|
const {
|
||||||
|
bootPopup,
|
||||||
|
cleanupPopup,
|
||||||
|
unversionedValidProfile,
|
||||||
|
TOKEN_ADDRESS,
|
||||||
|
} = require("./support/popupBoot");
|
||||||
|
const { applyChainSwitchFields } = require("../src/shared/chainSwitchFields");
|
||||||
|
|
||||||
|
afterEach(() => {
|
||||||
|
cleanupPopup();
|
||||||
|
});
|
||||||
|
|
||||||
|
// Starts the ten-second refresh and holds it open. The balance stand-in writes
|
||||||
|
// Ethereum Mainnet's balances in place, on the records handed in, as the real
|
||||||
|
// refreshBalances() does, once the returned function is called. Resolves with
|
||||||
|
// that function and the refresh still running.
|
||||||
|
async function holdRefresh(page) {
|
||||||
|
const { refreshBalances } = require("../src/shared/balances");
|
||||||
|
let answer;
|
||||||
|
refreshBalances.mockImplementationOnce(async (wallets) => {
|
||||||
|
await new Promise((resolve) => {
|
||||||
|
answer = resolve;
|
||||||
|
});
|
||||||
|
wallets[0].addresses[0].balance = "7.0";
|
||||||
|
wallets[0].addresses[0].tokenBalances = [
|
||||||
|
{
|
||||||
|
address: TOKEN_ADDRESS,
|
||||||
|
name: "Test Token",
|
||||||
|
symbol: "TST",
|
||||||
|
decimals: 18,
|
||||||
|
balance: "5.0",
|
||||||
|
holders: null,
|
||||||
|
},
|
||||||
|
];
|
||||||
|
});
|
||||||
|
const ticking = page.tick();
|
||||||
|
await page.settle();
|
||||||
|
return {
|
||||||
|
finish: async () => {
|
||||||
|
answer();
|
||||||
|
await ticking;
|
||||||
|
},
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
// Picks `networkId` in the Settings network selector, as the user does.
|
||||||
|
async function chooseNetwork(page, networkId) {
|
||||||
|
const select = page.node("settings-network");
|
||||||
|
select.value = networkId;
|
||||||
|
for (const fn of select.listeners.change) await fn();
|
||||||
|
await page.settle();
|
||||||
|
}
|
||||||
|
|
||||||
|
// The stored record holds none of Ethereum Mainnet's balances, and no refresh
|
||||||
|
// recorded as done.
|
||||||
|
function expectNothingStored(page) {
|
||||||
|
const stored = page.storage.read("autistmask");
|
||||||
|
expect(stored.networkId).toBe("sepolia");
|
||||||
|
expect(stored.wallets[0].addresses[0].balance).toBe("0");
|
||||||
|
expect(stored.wallets[0].addresses[0].tokenBalances).toEqual([]);
|
||||||
|
expect(stored.lastBalanceRefresh).toBe(0);
|
||||||
|
}
|
||||||
|
|
||||||
|
test("a refresh that returns after a switch in Settings writes nothing, and the next one runs on the new network", async () => {
|
||||||
|
const page = await bootPopup(unversionedValidProfile());
|
||||||
|
expect(page.pageErrors).toEqual([]);
|
||||||
|
const { refreshBalances } = require("../src/shared/balances");
|
||||||
|
const { state } = require("../src/shared/state");
|
||||||
|
|
||||||
|
const refresh = await holdRefresh(page);
|
||||||
|
await page.click("btn-settings");
|
||||||
|
await chooseNetwork(page, "sepolia");
|
||||||
|
await refresh.finish();
|
||||||
|
|
||||||
|
expect(state.wallets[0].addresses[0].balance).toBe("0");
|
||||||
|
expect(state.wallets[0].addresses[0].tokenBalances).toEqual([]);
|
||||||
|
expectNothingStored(page);
|
||||||
|
|
||||||
|
await page.click("btn-settings-back");
|
||||||
|
expect(page.visibleViews()).toEqual(["main"]);
|
||||||
|
expect(page.text("total-value")).toBe("0.0000 SepoliaETH");
|
||||||
|
|
||||||
|
await page.tick();
|
||||||
|
|
||||||
|
expect(refreshBalances.mock.lastCall[4]).toBe("sepolia");
|
||||||
|
expect(page.storage.read("autistmask").lastBalanceRefresh).toBeGreaterThan(
|
||||||
|
0,
|
||||||
|
);
|
||||||
|
});
|
||||||
|
|
||||||
|
// The switch is made only once the refresh's save, holding the lock, has
|
||||||
|
// written Ethereum Mainnet's balances, and the switch then clears them.
|
||||||
|
test("a refresh whose save is reading the stored record when the user switches in Settings leaves none of its balances stored", async () => {
|
||||||
|
const page = await bootPopup(unversionedValidProfile());
|
||||||
|
expect(page.pageErrors).toEqual([]);
|
||||||
|
const { state } = require("../src/shared/state");
|
||||||
|
|
||||||
|
const refresh = await holdRefresh(page);
|
||||||
|
await page.click("btn-settings");
|
||||||
|
|
||||||
|
// The next read of the stored record, the refresh's save's, is held.
|
||||||
|
const get = page.storage.local.get;
|
||||||
|
const read = get.getMockImplementation();
|
||||||
|
let releaseRead;
|
||||||
|
get.mockImplementationOnce(async (key) => {
|
||||||
|
await new Promise((resolve) => {
|
||||||
|
releaseRead = resolve;
|
||||||
|
});
|
||||||
|
return read(key);
|
||||||
|
});
|
||||||
|
const finishing = refresh.finish();
|
||||||
|
await page.settle();
|
||||||
|
|
||||||
|
// The user picks Sepolia meanwhile; the switch's own save waits for the
|
||||||
|
// refresh's save to let the lock go.
|
||||||
|
const select = page.node("settings-network");
|
||||||
|
select.value = "sepolia";
|
||||||
|
const switching = Promise.all(select.listeners.change.map((fn) => fn()));
|
||||||
|
await page.settle();
|
||||||
|
|
||||||
|
releaseRead();
|
||||||
|
await finishing;
|
||||||
|
await switching;
|
||||||
|
await page.settle();
|
||||||
|
|
||||||
|
expect(state.networkId).toBe("sepolia");
|
||||||
|
expect(state.wallets[0].addresses[0].balance).toBe("0");
|
||||||
|
expect(state.wallets[0].addresses[0].tokenBalances).toEqual([]);
|
||||||
|
expectNothingStored(page);
|
||||||
|
});
|
||||||
|
|
||||||
|
test("a refresh that returns after the background switched the network writes nothing", async () => {
|
||||||
|
const page = await bootPopup(unversionedValidProfile());
|
||||||
|
expect(page.pageErrors).toEqual([]);
|
||||||
|
const { saveState } = require("../src/shared/state");
|
||||||
|
|
||||||
|
const refresh = await holdRefresh(page);
|
||||||
|
// The background writes the switch to Sepolia, as its updateState() does
|
||||||
|
// once the user approves a site's request. This page is not told of it
|
||||||
|
// yet.
|
||||||
|
const record = page.storage.read("autistmask");
|
||||||
|
applyChainSwitchFields(record, "sepolia");
|
||||||
|
page.storage.write("autistmask", record);
|
||||||
|
await refresh.finish();
|
||||||
|
|
||||||
|
expectNothingStored(page);
|
||||||
|
|
||||||
|
// Nor does a later save by this page, such as every navigation makes.
|
||||||
|
await saveState();
|
||||||
|
|
||||||
|
expectNothingStored(page);
|
||||||
|
});
|
||||||
@@ -446,7 +446,10 @@ describe("switching the network in Settings tells every open tab", () => {
|
|||||||
global.chrome.runtime.sendMessage = (msg) => {
|
global.chrome.runtime.sendMessage = (msg) => {
|
||||||
bg.send(msg, POPUP);
|
bg.send(msg, POPUP);
|
||||||
};
|
};
|
||||||
await require("../src/shared/state").loadState();
|
const { state, loadState } = require("../src/shared/state");
|
||||||
|
await loadState();
|
||||||
|
// Set by showView(), which is mocked above.
|
||||||
|
state.currentView = "settings";
|
||||||
require("../src/popup/views/settings").init({
|
require("../src/popup/views/settings").init({
|
||||||
pageClosed: new AbortController().signal,
|
pageClosed: new AbortController().signal,
|
||||||
});
|
});
|
||||||
|
|||||||
@@ -158,7 +158,7 @@ global.document = {
|
|||||||
body: { prepend() {}, appendChild() {} },
|
body: { prepend() {}, appendChild() {} },
|
||||||
addEventListener() {},
|
addEventListener() {},
|
||||||
};
|
};
|
||||||
global.navigator = { clipboard: { writeText() {} } };
|
global.navigator.clipboard = { writeText() {} };
|
||||||
|
|
||||||
const {
|
const {
|
||||||
Interface,
|
Interface,
|
||||||
|
|||||||
@@ -189,7 +189,7 @@ global.document = {
|
|||||||
body: { prepend() {}, appendChild() {} },
|
body: { prepend() {}, appendChild() {} },
|
||||||
addEventListener() {},
|
addEventListener() {},
|
||||||
};
|
};
|
||||||
global.navigator = { clipboard: { writeText() {} } };
|
global.navigator.clipboard = { writeText() {} };
|
||||||
|
|
||||||
const {
|
const {
|
||||||
BaseWallet,
|
BaseWallet,
|
||||||
|
|||||||
@@ -867,6 +867,14 @@ step(
|
|||||||
"the page was not told of the approved switch: " +
|
"the page was not told of the approved switch: " +
|
||||||
JSON.stringify(events),
|
JSON.stringify(events),
|
||||||
);
|
);
|
||||||
|
// The popup, open all along, shows the new network
|
||||||
|
// (https://git.eeqj.de/sneak/AutistMask/issues/650).
|
||||||
|
await d.switchToWindow(env.popupWindow);
|
||||||
|
await d.waitFor(
|
||||||
|
"the open popup to show the testnet banner",
|
||||||
|
`const banner = document.getElementById("debug-banner");
|
||||||
|
return banner !== null && banner.textContent === "[TESTNET]";`,
|
||||||
|
);
|
||||||
|
|
||||||
await openNetworkPrompt(env, "switch-restore", sepolia, mainnet);
|
await openNetworkPrompt(env, "switch-restore", sepolia, mainnet);
|
||||||
await d.click("#btn-approve-network");
|
await d.click("#btn-approve-network");
|
||||||
@@ -881,6 +889,10 @@ step(
|
|||||||
isDeepStrictEqual(await storedNetwork(env), before),
|
isDeepStrictEqual(await storedNetwork(env), before),
|
||||||
"switching back did not restore the mainnet network and endpoints",
|
"switching back did not restore the mainnet network and endpoints",
|
||||||
);
|
);
|
||||||
|
await d.waitFor(
|
||||||
|
"the open popup to drop the testnet banner",
|
||||||
|
`return document.getElementById("debug-banner") === null;`,
|
||||||
|
);
|
||||||
await d.switchToWindow(env.dappWindow);
|
await d.switchToWindow(env.dappWindow);
|
||||||
},
|
},
|
||||||
);
|
);
|
||||||
|
|||||||
+31
-1
@@ -367,11 +367,14 @@ async function leaveTransactionDetail(page) {
|
|||||||
await openAddressDetail(page);
|
await openAddressDetail(page);
|
||||||
}
|
}
|
||||||
|
|
||||||
// Back out to Home from wherever the previous test finished.
|
// Back out to Home from wherever the previous test finished, and wait for the
|
||||||
|
// save that navigation makes, so a test reading the stored stack next reads
|
||||||
|
// the one Home left.
|
||||||
async function goHome(page) {
|
async function goHome(page) {
|
||||||
await leaveTransactionDetail(page);
|
await leaveTransactionDetail(page);
|
||||||
await page.click("#btn-address-back");
|
await page.click("#btn-address-back");
|
||||||
await visible(page, "#view-main");
|
await visible(page, "#view-main");
|
||||||
|
await waitForPersisted(page, "currentView", "main", "back on Home");
|
||||||
}
|
}
|
||||||
|
|
||||||
// One field of the popup's state as it was actually persisted, read out of
|
// One field of the popup's state as it was actually persisted, read out of
|
||||||
@@ -3477,6 +3480,24 @@ function hostileSymbolState(page, tokenAddress) {
|
|||||||
}
|
}
|
||||||
|
|
||||||
test("a token whose symbol() returns markup renders as text (#307)", async (env) => {
|
test("a token whose symbol() returns markup renders as text (#307)", async (env) => {
|
||||||
|
// The stub token is no longer tracked from here on, so the explorer is
|
||||||
|
// what lists it, as it lists a token airdropped to the victim. A tracked
|
||||||
|
// token is listed from the RPC endpoint under the symbol it was added
|
||||||
|
// with, which the hostile symbol below never reaches
|
||||||
|
// (https://git.eeqj.de/sneak/AutistMask/issues/669).
|
||||||
|
await env.page.click("#btn-settings");
|
||||||
|
await visible(env.page, "#view-settings");
|
||||||
|
await env.page.click("#settings-tracked-tokens .btn-remove-token");
|
||||||
|
// The list is drawn again once the removal is saved.
|
||||||
|
await env.page.waitForFunction(
|
||||||
|
() =>
|
||||||
|
document
|
||||||
|
.getElementById("settings-tracked-tokens")
|
||||||
|
.innerText.trim() === "None",
|
||||||
|
);
|
||||||
|
await env.page.click("#btn-settings-back");
|
||||||
|
await visible(env.page, "#view-address");
|
||||||
|
|
||||||
env.routeOpts.ethBalanceWei = toHexWei(FUNDED_ETH_WEI);
|
env.routeOpts.ethBalanceWei = toHexWei(FUNDED_ETH_WEI);
|
||||||
env.routeOpts.seedTokenBalance = true;
|
env.routeOpts.seedTokenBalance = true;
|
||||||
env.routeOpts.tokenSymbolOverride = HOSTILE_SYMBOL;
|
env.routeOpts.tokenSymbolOverride = HOSTILE_SYMBOL;
|
||||||
@@ -4862,6 +4883,12 @@ test("a site's network switch changes nothing until the user approves it (#408)"
|
|||||||
"the page was not told of the approved switch: " +
|
"the page was not told of the approved switch: " +
|
||||||
JSON.stringify(events),
|
JSON.stringify(events),
|
||||||
);
|
);
|
||||||
|
// The popup, open all along, shows the new network
|
||||||
|
// (https://git.eeqj.de/sneak/AutistMask/issues/650).
|
||||||
|
await env.page.waitForFunction(() => {
|
||||||
|
const banner = document.getElementById("debug-banner");
|
||||||
|
return banner !== null && banner.textContent === "[TESTNET]";
|
||||||
|
});
|
||||||
|
|
||||||
const restored = await openNetworkPrompt(
|
const restored = await openNetworkPrompt(
|
||||||
env,
|
env,
|
||||||
@@ -4883,6 +4910,9 @@ test("a site's network switch changes nothing until the user approves it (#408)"
|
|||||||
isDeepStrictEqual(await storedNetwork(env.page), before),
|
isDeepStrictEqual(await storedNetwork(env.page), before),
|
||||||
"switching back did not restore the mainnet network and endpoints",
|
"switching back did not restore the mainnet network and endpoints",
|
||||||
);
|
);
|
||||||
|
await env.page.waitForFunction(
|
||||||
|
() => document.getElementById("debug-banner") === null,
|
||||||
|
);
|
||||||
});
|
});
|
||||||
|
|
||||||
// Switching the network in Settings tells the page too, as an approved site
|
// Switching the network in Settings tells the page too, as an approved site
|
||||||
|
|||||||
@@ -151,7 +151,7 @@ global.document = {
|
|||||||
body: { prepend() {}, appendChild() {} },
|
body: { prepend() {}, appendChild() {} },
|
||||||
addEventListener() {},
|
addEventListener() {},
|
||||||
};
|
};
|
||||||
global.navigator = { clipboard: { writeText() {} } };
|
global.navigator.clipboard = { writeText() {} };
|
||||||
|
|
||||||
const { state } = require("../src/shared/state");
|
const { state } = require("../src/shared/state");
|
||||||
const { NETWORKS } = require("../src/shared/networks");
|
const { NETWORKS } = require("../src/shared/networks");
|
||||||
|
|||||||
@@ -364,7 +364,7 @@ describe("a save that fails", () => {
|
|||||||
return storage;
|
return storage;
|
||||||
}
|
}
|
||||||
|
|
||||||
test("is reported, not swallowed by the save queue", async () => {
|
test("is reported when the caller does not await it", async () => {
|
||||||
const storage = failingStorage(unversionedValidProfile());
|
const storage = failingStorage(unversionedValidProfile());
|
||||||
const { state, loadState, saveState, onSaveFailure } =
|
const { state, loadState, saveState, onSaveFailure } =
|
||||||
loadStateModule(storage);
|
loadStateModule(storage);
|
||||||
|
|||||||
@@ -0,0 +1,300 @@
|
|||||||
|
// An open popup follows a network switch the background saves once the user
|
||||||
|
// approves a site's request: it takes the new network from the stored record
|
||||||
|
// and draws the screen it is on for it, as a switch in Settings does
|
||||||
|
// (https://git.eeqj.de/sneak/AutistMask/issues/650). Driven through the real
|
||||||
|
// popup over a stored profile on Ethereum Mainnet. The background's write is
|
||||||
|
// the storage stub's set, which the stub reports to the page as the browser
|
||||||
|
// does.
|
||||||
|
|
||||||
|
const {
|
||||||
|
bootPopup,
|
||||||
|
cleanupPopup,
|
||||||
|
unversionedValidProfile,
|
||||||
|
TOKEN_ADDRESS,
|
||||||
|
} = require("./support/popupBoot");
|
||||||
|
const { makeStorageStub } = require("./support/storageStub");
|
||||||
|
const {
|
||||||
|
applyChainSwitchFields,
|
||||||
|
copyChainSwitchFields,
|
||||||
|
} = require("../src/shared/chainSwitchFields");
|
||||||
|
const { NETWORKS } = require("../src/shared/networks");
|
||||||
|
const { STATE_SCHEMA_VERSION } = require("../src/shared/stateSchema");
|
||||||
|
|
||||||
|
afterEach(() => {
|
||||||
|
cleanupPopup();
|
||||||
|
});
|
||||||
|
|
||||||
|
const SEPOLIA_TOKEN = {
|
||||||
|
address: TOKEN_ADDRESS,
|
||||||
|
symbol: "TST",
|
||||||
|
decimals: 18,
|
||||||
|
name: "Test Token",
|
||||||
|
};
|
||||||
|
const MAINNET_TOKEN = {
|
||||||
|
address: "0x6B175474E89094C44Da98b954EedeAC495271d0F",
|
||||||
|
symbol: "DAI",
|
||||||
|
decimals: 18,
|
||||||
|
name: "Dai Stablecoin",
|
||||||
|
};
|
||||||
|
|
||||||
|
// A profile on Ethereum Mainnet that reopens the popup onto AddressDetail,
|
||||||
|
// with DAI tracked there and TST tracked on Sepolia.
|
||||||
|
function profileOnAddress() {
|
||||||
|
return unversionedValidProfile({
|
||||||
|
currentView: "address",
|
||||||
|
viewStack: ["main"],
|
||||||
|
selectedWallet: 0,
|
||||||
|
selectedAddress: 0,
|
||||||
|
trackedTokens: [MAINNET_TOKEN],
|
||||||
|
networkTrackedTokens: { sepolia: [SEPOLIA_TOKEN] },
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
// The popup reopened onto it.
|
||||||
|
function bootOnAddress() {
|
||||||
|
return bootPopup(profileOnAddress());
|
||||||
|
}
|
||||||
|
|
||||||
|
// The background saves a switch to `networkId`, as its updateState() does
|
||||||
|
// once the user approves a site's request.
|
||||||
|
async function backgroundSwitch(page, networkId) {
|
||||||
|
const record = page.storage.read("autistmask");
|
||||||
|
applyChainSwitchFields(record, networkId);
|
||||||
|
await page.storage.local.set({ autistmask: record });
|
||||||
|
await page.settle();
|
||||||
|
await page.settle();
|
||||||
|
}
|
||||||
|
|
||||||
|
test("the popup open on AddressDetail shows the new network and its balances", async () => {
|
||||||
|
const page = await bootOnAddress();
|
||||||
|
expect(page.pageErrors).toEqual([]);
|
||||||
|
expect(page.visibleViews()).toEqual(["address"]);
|
||||||
|
expect(page.node("address-balances").innerHTML).toContain("DAI");
|
||||||
|
expect(page.node("debug-banner")).toBeNull();
|
||||||
|
|
||||||
|
await backgroundSwitch(page, "sepolia");
|
||||||
|
|
||||||
|
const { state } = require("../src/shared/state");
|
||||||
|
expect(state.networkId).toBe("sepolia");
|
||||||
|
expect(state.rpcUrl).toBe(NETWORKS.sepolia.defaultRpcUrl);
|
||||||
|
expect(page.visibleViews()).toEqual(["address"]);
|
||||||
|
const balances = page.node("address-balances").innerHTML;
|
||||||
|
expect(balances).toContain("TST");
|
||||||
|
expect(balances).toContain("SepoliaETH");
|
||||||
|
expect(balances).not.toContain("DAI");
|
||||||
|
expect(page.text("debug-banner")).toBe("[TESTNET]");
|
||||||
|
|
||||||
|
// Its next refresh runs on Sepolia, and what it fetched is stored.
|
||||||
|
await page.tick();
|
||||||
|
const { refreshBalances } = require("../src/shared/balances");
|
||||||
|
expect(refreshBalances.mock.lastCall[4]).toBe("sepolia");
|
||||||
|
const stored = page.storage.read("autistmask");
|
||||||
|
expect(stored.networkId).toBe("sepolia");
|
||||||
|
expect(stored.lastBalanceRefresh).toBeGreaterThan(0);
|
||||||
|
});
|
||||||
|
|
||||||
|
test("the popup open on Settings shows the new network, and Back draws the screen beneath for it", async () => {
|
||||||
|
const page = await bootOnAddress();
|
||||||
|
await page.click("btn-settings");
|
||||||
|
expect(page.visibleViews()).toEqual(["settings"]);
|
||||||
|
|
||||||
|
await backgroundSwitch(page, "sepolia");
|
||||||
|
|
||||||
|
expect(page.visibleViews()).toEqual(["settings"]);
|
||||||
|
expect(page.value("settings-network")).toBe("sepolia");
|
||||||
|
expect(page.value("settings-rpc")).toBe(NETWORKS.sepolia.defaultRpcUrl);
|
||||||
|
expect(page.node("settings-tracked-tokens").innerHTML).toContain("TST");
|
||||||
|
expect(page.text("debug-banner")).toBe("[TESTNET]");
|
||||||
|
|
||||||
|
await page.click("btn-settings-back");
|
||||||
|
expect(page.visibleViews()).toEqual(["address"]);
|
||||||
|
expect(page.node("address-balances").innerHTML).not.toContain("DAI");
|
||||||
|
});
|
||||||
|
|
||||||
|
// Neither can be drawn again for the new network: Send cannot be rendered from
|
||||||
|
// saved state, and DAI was picked on Ethereum Mainnet, where alone it is
|
||||||
|
// tracked. A reopened popup goes to Home in their place.
|
||||||
|
test.each([
|
||||||
|
["Send", (page) => page.click("btn-send")],
|
||||||
|
[
|
||||||
|
"AddressToken for DAI",
|
||||||
|
async (page) => {
|
||||||
|
const { state } = require("../src/shared/state");
|
||||||
|
state.selectedToken = MAINNET_TOKEN.address;
|
||||||
|
require("../src/popup/views/helpers").pushCurrentView();
|
||||||
|
require("../src/popup/views/addressToken").show();
|
||||||
|
await page.settle();
|
||||||
|
},
|
||||||
|
],
|
||||||
|
])("the popup open on %s goes to Home", async (_view, open) => {
|
||||||
|
const page = await bootOnAddress();
|
||||||
|
await open(page);
|
||||||
|
expect(page.visibleViews()).not.toEqual(["address"]);
|
||||||
|
|
||||||
|
await backgroundSwitch(page, "sepolia");
|
||||||
|
|
||||||
|
expect(page.visibleViews()).toEqual(["main"]);
|
||||||
|
expect(page.text("total-value")).toBe("0.0000 SepoliaETH");
|
||||||
|
});
|
||||||
|
|
||||||
|
// The report of the switch's own save names the network the page already has.
|
||||||
|
test("a switch in Settings is not taken a second time when its save is reported", async () => {
|
||||||
|
const page = await bootOnAddress();
|
||||||
|
await page.click("btn-settings");
|
||||||
|
const { get, set } = page.storage.local;
|
||||||
|
const reads = get.mock.calls.length;
|
||||||
|
const writes = set.mock.calls.length;
|
||||||
|
|
||||||
|
const select = page.node("settings-network");
|
||||||
|
select.value = "sepolia";
|
||||||
|
for (const fn of select.listeners.change) await fn();
|
||||||
|
await page.settle();
|
||||||
|
await page.settle();
|
||||||
|
|
||||||
|
expect(get).toHaveBeenCalledTimes(reads + 1);
|
||||||
|
expect(set).toHaveBeenCalledTimes(writes + 1);
|
||||||
|
expect(page.text("flash-msg")).toBe("Switched to Sepolia Testnet.");
|
||||||
|
});
|
||||||
|
|
||||||
|
// The background saves the switch once the popup has read the stored record
|
||||||
|
// and before it listens for changes to it, so the browser tells the page
|
||||||
|
// nothing of it. Nor is any later write reported here: Chrome reports none
|
||||||
|
// that leaves the record as it was, such as the popup's own save at start-up.
|
||||||
|
test("a switch saved while the popup opens, before it listens for one, is followed", async () => {
|
||||||
|
const storage = makeStorageStub({ autistmask: profileOnAddress() });
|
||||||
|
storage.onChanged = { addListener: () => {} };
|
||||||
|
const read = storage.local.get.getMockImplementation();
|
||||||
|
storage.local.get.mockImplementationOnce(async (key) => {
|
||||||
|
const loaded = await read(key);
|
||||||
|
const record = storage.read("autistmask");
|
||||||
|
applyChainSwitchFields(record, "sepolia");
|
||||||
|
storage.write("autistmask", record);
|
||||||
|
return loaded;
|
||||||
|
});
|
||||||
|
const page = await bootPopup(undefined, { storage });
|
||||||
|
await page.settle();
|
||||||
|
|
||||||
|
const { state } = require("../src/shared/state");
|
||||||
|
expect(page.pageErrors).toEqual([]);
|
||||||
|
expect(state.networkId).toBe("sepolia");
|
||||||
|
expect(page.visibleViews()).toEqual(["address"]);
|
||||||
|
expect(page.node("address-balances").innerHTML).toContain("SepoliaETH");
|
||||||
|
expect(page.text("debug-banner")).toBe("[TESTNET]");
|
||||||
|
});
|
||||||
|
|
||||||
|
// While the popup's follow of the background's switch to Sepolia waits for the
|
||||||
|
// lock, the user picks Sepolia in Settings and then Ethereum Mainnet again. The
|
||||||
|
// last pick is the network stored, and the last one sites are told of.
|
||||||
|
test("a switch in Settings made while a follow waits for the lock is not overwritten by it", async () => {
|
||||||
|
const page = await bootOnAddress();
|
||||||
|
await page.click("btn-settings");
|
||||||
|
|
||||||
|
// Another write holds the lock, so every save of the page waits for it.
|
||||||
|
let releaseLock;
|
||||||
|
const lockHeld = navigator.locks.request(
|
||||||
|
"autistmask",
|
||||||
|
() =>
|
||||||
|
new Promise((resolve) => {
|
||||||
|
releaseLock = resolve;
|
||||||
|
}),
|
||||||
|
);
|
||||||
|
await backgroundSwitch(page, "sepolia");
|
||||||
|
const select = page.node("settings-network");
|
||||||
|
const picks = [];
|
||||||
|
for (const networkId of ["sepolia", "mainnet"]) {
|
||||||
|
select.value = networkId;
|
||||||
|
for (const fn of select.listeners.change) picks.push(fn());
|
||||||
|
}
|
||||||
|
releaseLock();
|
||||||
|
await lockHeld;
|
||||||
|
await Promise.all(picks);
|
||||||
|
await page.settle();
|
||||||
|
|
||||||
|
const { state } = require("../src/shared/state");
|
||||||
|
expect(state.networkId).toBe("mainnet");
|
||||||
|
expect(page.storage.read("autistmask").networkId).toBe("mainnet");
|
||||||
|
expect(page.value("settings-network")).toBe("mainnet");
|
||||||
|
const told = globalThis.chrome.runtime.sendMessage.mock.calls
|
||||||
|
.map(([message]) => message)
|
||||||
|
.filter((message) => message.type === "AUTISTMASK_NETWORK_CHANGED");
|
||||||
|
expect(told.at(-1).chainId).toBe(NETWORKS.mainnet.chainId);
|
||||||
|
});
|
||||||
|
|
||||||
|
// The popup follows the background's switch to Sepolia, but its own write in
|
||||||
|
// that save fails. The user then picks Ethereum Mainnet in Settings, the
|
||||||
|
// network the popup was on before: that switch is stored, and only then
|
||||||
|
// flashed and sent to sites.
|
||||||
|
test("a switch back in Settings after a follow whose write failed is stored", async () => {
|
||||||
|
const page = await bootOnAddress();
|
||||||
|
await page.click("btn-settings");
|
||||||
|
const { set } = page.storage.local;
|
||||||
|
const write = set.getMockImplementation();
|
||||||
|
// The background's write lands; the next, the follow's, fails.
|
||||||
|
set.mockImplementationOnce(write).mockRejectedValueOnce(
|
||||||
|
new Error("quota exceeded"),
|
||||||
|
);
|
||||||
|
await backgroundSwitch(page, "sepolia");
|
||||||
|
const { state } = require("../src/shared/state");
|
||||||
|
expect(state.networkId).toBe("sepolia");
|
||||||
|
|
||||||
|
const select = page.node("settings-network");
|
||||||
|
select.value = "mainnet";
|
||||||
|
for (const fn of select.listeners.change) await fn();
|
||||||
|
await page.settle();
|
||||||
|
|
||||||
|
const stored = page.storage.read("autistmask");
|
||||||
|
expect(stored.networkId).toBe("mainnet");
|
||||||
|
expect(stored.rpcUrl).toBe(NETWORKS.mainnet.defaultRpcUrl);
|
||||||
|
expect(stored.trackedTokens).toEqual([MAINNET_TOKEN]);
|
||||||
|
expect(page.text("flash-msg")).toBe("Switched to Ethereum Mainnet.");
|
||||||
|
const told = globalThis.chrome.runtime.sendMessage.mock.calls
|
||||||
|
.map(([message]) => message)
|
||||||
|
.filter((message) => message.type === "AUTISTMASK_NETWORK_CHANGED");
|
||||||
|
expect(told.at(-1).chainId).toBe(NETWORKS.mainnet.chainId);
|
||||||
|
});
|
||||||
|
|
||||||
|
// 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
|
||||||
|
// before.
|
||||||
|
test("a record that names no network is not followed", async () => {
|
||||||
|
const page = await bootOnAddress();
|
||||||
|
const { get, set } = page.storage.local;
|
||||||
|
const reads = get.mock.calls.length;
|
||||||
|
|
||||||
|
await set({
|
||||||
|
autistmask: {
|
||||||
|
schemaVersion: STATE_SCHEMA_VERSION + 1,
|
||||||
|
wallets: [{ type: "hd", name: "Main", addresses: [] }],
|
||||||
|
},
|
||||||
|
});
|
||||||
|
await page.settle();
|
||||||
|
|
||||||
|
expect(get).toHaveBeenCalledTimes(reads);
|
||||||
|
expect(page.visibleViews()).toEqual(["address"]);
|
||||||
|
});
|
||||||
|
|
||||||
|
// A record that takes the switch from the switched record ends up as that
|
||||||
|
// record, balances the background fetched since included.
|
||||||
|
test("copyChainSwitchFields() takes every field applyChainSwitchFields() sets", () => {
|
||||||
|
const before = unversionedValidProfile({
|
||||||
|
trackedTokens: [MAINNET_TOKEN],
|
||||||
|
networkTrackedTokens: { sepolia: [SEPOLIA_TOKEN] },
|
||||||
|
networkEndpoints: {
|
||||||
|
sepolia: {
|
||||||
|
rpcUrl: "http://127.0.0.1:8545",
|
||||||
|
blockscoutUrl: "http://127.0.0.1:4000/api/v2",
|
||||||
|
},
|
||||||
|
},
|
||||||
|
lastBalanceRefresh: 1,
|
||||||
|
tokenHolderCache: { [MAINNET_TOKEN.address]: 5000 },
|
||||||
|
fraudContracts: ["0x1111111111111111111111111111111111111111"],
|
||||||
|
});
|
||||||
|
const switched = structuredClone(before);
|
||||||
|
applyChainSwitchFields(switched, "sepolia");
|
||||||
|
switched.wallets[0].addresses[0].balance = "2.0";
|
||||||
|
|
||||||
|
const follower = structuredClone(before);
|
||||||
|
copyChainSwitchFields(follower, switched);
|
||||||
|
|
||||||
|
expect(follower).toEqual(switched);
|
||||||
|
});
|
||||||
@@ -97,7 +97,7 @@ global.document = {
|
|||||||
body: { prepend() {}, appendChild() {} },
|
body: { prepend() {}, appendChild() {} },
|
||||||
addEventListener() {},
|
addEventListener() {},
|
||||||
};
|
};
|
||||||
global.navigator = { clipboard: { writeText() {} } };
|
global.navigator.clipboard = { writeText() {} };
|
||||||
|
|
||||||
const { state } = require("../src/shared/state");
|
const { state } = require("../src/shared/state");
|
||||||
const send = require("../src/popup/views/send");
|
const send = require("../src/popup/views/send");
|
||||||
|
|||||||
@@ -151,7 +151,7 @@ global.document = {
|
|||||||
body: { prepend() {}, appendChild() {} },
|
body: { prepend() {}, appendChild() {} },
|
||||||
addEventListener() {},
|
addEventListener() {},
|
||||||
};
|
};
|
||||||
global.navigator = { clipboard: { writeText() {} } };
|
global.navigator.clipboard = { writeText() {} };
|
||||||
|
|
||||||
const { refreshBalances } = require("../src/shared/balances");
|
const { refreshBalances } = require("../src/shared/balances");
|
||||||
const { state } = require("../src/shared/state");
|
const { state } = require("../src/shared/state");
|
||||||
|
|||||||
@@ -146,7 +146,7 @@ global.document = {
|
|||||||
body: { prepend() {}, appendChild() {} },
|
body: { prepend() {}, appendChild() {} },
|
||||||
addEventListener() {},
|
addEventListener() {},
|
||||||
};
|
};
|
||||||
global.navigator = { clipboard: { writeText() {} } };
|
global.navigator.clipboard = { writeText() {} };
|
||||||
|
|
||||||
const { Transaction, Wallet, formatEther } = require("ethers");
|
const { Transaction, Wallet, formatEther } = require("ethers");
|
||||||
const { refreshBalances } = require("../src/shared/balances");
|
const { refreshBalances } = require("../src/shared/balances");
|
||||||
|
|||||||
@@ -160,7 +160,7 @@ describe("the approval-window reproduction", () => {
|
|||||||
await approvalWindow.state.loadState();
|
await approvalWindow.state.loadState();
|
||||||
approvalWindow.helpers.showView("approve-tx");
|
approvalWindow.helpers.showView("approve-tx");
|
||||||
// showView() does not await its own saveState(); an extra save
|
// showView() does not await its own saveState(); an extra save
|
||||||
// joins the same queue and only resolves once that one has too,
|
// waits for the lock behind that one and so resolves only after it,
|
||||||
// which is the black-box way to know it landed.
|
// which is the black-box way to know it landed.
|
||||||
await approvalWindow.state.saveState();
|
await approvalWindow.state.saveState();
|
||||||
|
|
||||||
|
|||||||
@@ -0,0 +1,96 @@
|
|||||||
|
// A popup save reads the stored record, merges this page's changes into it
|
||||||
|
// and writes it back. The background's write of a network the user approved
|
||||||
|
// used to be able to land between that read and that write, and the popup's
|
||||||
|
// write then put the old network back
|
||||||
|
// (https://git.eeqj.de/sneak/AutistMask/issues/641). Every write of the record
|
||||||
|
// now holds a lock from its read to its write.
|
||||||
|
//
|
||||||
|
// 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
|
||||||
|
// a Firefox private window share the browser's
|
||||||
|
// (tests/support/navigatorLocks.js).
|
||||||
|
|
||||||
|
const { makeStorageStub } = require("./support/storageStub");
|
||||||
|
|
||||||
|
function loadContexts(storage) {
|
||||||
|
jest.resetModules();
|
||||||
|
globalThis.chrome = { storage: { local: storage.local } };
|
||||||
|
return {
|
||||||
|
popup: require("../src/shared/state"),
|
||||||
|
background: require("../src/background/state"),
|
||||||
|
applyChainSwitchFields: require("../src/shared/chainSwitchFields")
|
||||||
|
.applyChainSwitchFields,
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
// Lets every pending promise callback run, and then some.
|
||||||
|
function nextMacrotask() {
|
||||||
|
return new Promise((resolve) => setImmediate(resolve));
|
||||||
|
}
|
||||||
|
|
||||||
|
afterEach(() => {
|
||||||
|
delete globalThis.chrome;
|
||||||
|
jest.restoreAllMocks();
|
||||||
|
});
|
||||||
|
|
||||||
|
test("a network the background switches to during a popup save stays stored", async () => {
|
||||||
|
const storage = makeStorageStub({ autistmask: { networkId: "sepolia" } });
|
||||||
|
const { popup, background, applyChainSwitchFields } = loadContexts(storage);
|
||||||
|
await popup.loadState();
|
||||||
|
|
||||||
|
// The popup navigates, so its save has a change of its own to write.
|
||||||
|
popup.state.currentView = "settings";
|
||||||
|
|
||||||
|
// The popup's save has read the record and is about to write it back when
|
||||||
|
// the user's approval of a site's switch to mainnet reaches the
|
||||||
|
// background. Without the lock the background's whole update runs before
|
||||||
|
// the next macrotask; with it, the update waits for the popup's write.
|
||||||
|
let backgroundSwitch;
|
||||||
|
const realSet = storage.local.set.getMockImplementation();
|
||||||
|
storage.local.set.mockImplementationOnce(async (items) => {
|
||||||
|
backgroundSwitch = background.updateState((fresh) =>
|
||||||
|
applyChainSwitchFields(fresh, "mainnet"),
|
||||||
|
);
|
||||||
|
await nextMacrotask();
|
||||||
|
return realSet(items);
|
||||||
|
});
|
||||||
|
|
||||||
|
await popup.saveState();
|
||||||
|
await backgroundSwitch;
|
||||||
|
|
||||||
|
const stored = storage.read("autistmask");
|
||||||
|
expect(stored.networkId).toBe("mainnet");
|
||||||
|
expect(stored.currentView).toBe("settings");
|
||||||
|
});
|
||||||
|
|
||||||
|
test("after a save that failed, the next save still keeps a network the background switches to during it", async () => {
|
||||||
|
jest.spyOn(console, "error").mockImplementation(() => {});
|
||||||
|
const storage = makeStorageStub({ autistmask: { networkId: "sepolia" } });
|
||||||
|
const { popup, background, applyChainSwitchFields } = loadContexts(storage);
|
||||||
|
await popup.loadState();
|
||||||
|
popup.state.currentView = "settings";
|
||||||
|
|
||||||
|
// The first save's write is refused, so it gives the lock back having
|
||||||
|
// failed.
|
||||||
|
storage.local.set.mockRejectedValueOnce(new Error("quota exceeded"));
|
||||||
|
await expect(popup.saveState()).rejects.toThrow("quota exceeded");
|
||||||
|
|
||||||
|
// The next save is between its read and its write when the background
|
||||||
|
// switches to mainnet, as in the test above.
|
||||||
|
let backgroundSwitch;
|
||||||
|
const realSet = storage.local.set.getMockImplementation();
|
||||||
|
storage.local.set.mockImplementationOnce(async (items) => {
|
||||||
|
backgroundSwitch = background.updateState((fresh) =>
|
||||||
|
applyChainSwitchFields(fresh, "mainnet"),
|
||||||
|
);
|
||||||
|
await nextMacrotask();
|
||||||
|
return realSet(items);
|
||||||
|
});
|
||||||
|
|
||||||
|
await popup.saveState();
|
||||||
|
await backgroundSwitch;
|
||||||
|
|
||||||
|
const stored = storage.read("autistmask");
|
||||||
|
expect(stored.networkId).toBe("mainnet");
|
||||||
|
expect(stored.currentView).toBe("settings");
|
||||||
|
});
|
||||||
@@ -0,0 +1,27 @@
|
|||||||
|
// `navigator.locks` for the unit tests, which run on node, where there is none.
|
||||||
|
//
|
||||||
|
// One lock per name: granted in the order it was asked for, and let go when
|
||||||
|
// the callback settles, whether it resolved or rejected. That is what the
|
||||||
|
// browser's own does for the one call the extension makes,
|
||||||
|
// `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,
|
||||||
|
// except a page in a Firefox private window (README, "Stored state and its
|
||||||
|
// version").
|
||||||
|
//
|
||||||
|
// Run before each test file by `setupFiles` in package.json.
|
||||||
|
|
||||||
|
// For each name, a promise that settles once the last request for it has
|
||||||
|
// let the lock go.
|
||||||
|
const released = new Map();
|
||||||
|
|
||||||
|
function request(name, callback) {
|
||||||
|
const previous = released.get(name) || Promise.resolve();
|
||||||
|
const result = previous.then(() => callback({ name, mode: "exclusive" }));
|
||||||
|
released.set(
|
||||||
|
name,
|
||||||
|
result.catch(() => {}),
|
||||||
|
);
|
||||||
|
return result;
|
||||||
|
}
|
||||||
|
|
||||||
|
globalThis.navigator = { locks: { request } };
|
||||||
@@ -311,7 +311,7 @@ async function bootPopup(stored, options) {
|
|||||||
const windowListeners = {};
|
const windowListeners = {};
|
||||||
|
|
||||||
globalThis.chrome = {
|
globalThis.chrome = {
|
||||||
storage: { local: storage.local },
|
storage: { local: storage.local, onChanged: storage.onChanged },
|
||||||
runtime: {
|
runtime: {
|
||||||
sendMessage: jest.fn(async () => ({})),
|
sendMessage: jest.fn(async () => ({})),
|
||||||
getURL: (p) => "chrome-extension://autistmask/" + p,
|
getURL: (p) => "chrome-extension://autistmask/" + p,
|
||||||
|
|||||||
@@ -18,7 +18,9 @@
|
|||||||
// a storage stub by hand.
|
// a storage stub by hand.
|
||||||
|
|
||||||
// One storage area: get, set and remove over its own store, cloning both ways.
|
// One storage area: get, set and remove over its own store, cloning both ways.
|
||||||
function makeArea(store, tick) {
|
// `changed` is handed what each set or remove changed, in the shape
|
||||||
|
// storage.onChanged reports it.
|
||||||
|
function makeArea(store, tick, changed) {
|
||||||
const get = jest.fn(async (key) => {
|
const get = jest.fn(async (key) => {
|
||||||
tick();
|
tick();
|
||||||
if (key === undefined || key === null) return structuredClone(store);
|
if (key === undefined || key === null) return structuredClone(store);
|
||||||
@@ -34,14 +36,25 @@ function makeArea(store, tick) {
|
|||||||
|
|
||||||
const set = jest.fn(async (items) => {
|
const set = jest.fn(async (items) => {
|
||||||
tick();
|
tick();
|
||||||
|
const changes = {};
|
||||||
for (const k of Object.keys(items)) {
|
for (const k of Object.keys(items)) {
|
||||||
|
changes[k] = structuredClone({
|
||||||
|
oldValue: store[k],
|
||||||
|
newValue: items[k],
|
||||||
|
});
|
||||||
store[k] = structuredClone(items[k]);
|
store[k] = structuredClone(items[k]);
|
||||||
}
|
}
|
||||||
|
changed(changes);
|
||||||
});
|
});
|
||||||
|
|
||||||
const remove = jest.fn(async (key) => {
|
const remove = jest.fn(async (key) => {
|
||||||
tick();
|
tick();
|
||||||
for (const k of Array.isArray(key) ? key : [key]) delete store[k];
|
const changes = {};
|
||||||
|
for (const k of Array.isArray(key) ? key : [key]) {
|
||||||
|
changes[k] = { oldValue: store[k] };
|
||||||
|
delete store[k];
|
||||||
|
}
|
||||||
|
changed(changes);
|
||||||
});
|
});
|
||||||
|
|
||||||
return { get, set, remove };
|
return { get, set, remove };
|
||||||
@@ -54,12 +67,22 @@ function makeArea(store, tick) {
|
|||||||
function makeStorageStub(initial, onOp) {
|
function makeStorageStub(initial, onOp) {
|
||||||
const store = initial ? structuredClone(initial) : {};
|
const store = initial ? structuredClone(initial) : {};
|
||||||
const tick = onOp || (() => {});
|
const tick = onOp || (() => {});
|
||||||
const local = makeArea(store, tick);
|
// storage.onChanged: after a set or remove has finished, every listener is
|
||||||
|
// called with what it changed and the area's name, as the browser calls
|
||||||
|
// them for a write by any page or the background.
|
||||||
|
const listeners = [];
|
||||||
|
const announce = (areaName) => (changes) => {
|
||||||
|
Promise.resolve().then(() => {
|
||||||
|
for (const fn of listeners) fn(structuredClone(changes), areaName);
|
||||||
|
});
|
||||||
|
};
|
||||||
|
const local = makeArea(store, tick, announce("local"));
|
||||||
|
|
||||||
return {
|
return {
|
||||||
// Drop this straight in as chrome.storage.
|
// Drop this straight in as chrome.storage.
|
||||||
local,
|
local,
|
||||||
session: makeArea({}, tick),
|
session: makeArea({}, tick, announce("session")),
|
||||||
|
onChanged: { addListener: (fn) => listeners.push(fn) },
|
||||||
get: local.get,
|
get: local.get,
|
||||||
set: local.set,
|
set: local.set,
|
||||||
remove: local.remove,
|
remove: local.remove,
|
||||||
@@ -71,7 +94,9 @@ function makeStorageStub(initial, onOp) {
|
|||||||
? structuredClone(store)
|
? structuredClone(store)
|
||||||
: structuredClone(store[key]),
|
: structuredClone(store[key]),
|
||||||
// Seed or replace a record without going through the module under
|
// Seed or replace a record without going through the module under
|
||||||
// test — for standing in as "another page wrote this".
|
// test — for standing in as "another page wrote this". Nothing is
|
||||||
|
// announced to storage.onChanged, so it also stands in for the time
|
||||||
|
// before the browser tells this page of such a write.
|
||||||
write: (key, value) => {
|
write: (key, value) => {
|
||||||
store[key] = structuredClone(value);
|
store[key] = structuredClone(value);
|
||||||
},
|
},
|
||||||
|
|||||||
@@ -0,0 +1,303 @@
|
|||||||
|
// The balance of each token the user tracks is read with balanceOf through the
|
||||||
|
// RPC endpoint, for every address. Blockscout's answer gives a tracked token its
|
||||||
|
// holder count and decimals, and adds the tokens the user has not tracked
|
||||||
|
// (https://git.eeqj.de/sneak/AutistMask/issues/669).
|
||||||
|
//
|
||||||
|
// The real refreshBalances() runs against a fake JSON-RPC node, answered
|
||||||
|
// through ethers' own request hook, and a fake Blockscout, answered through
|
||||||
|
// fetch().
|
||||||
|
|
||||||
|
const { AbiCoder, FetchRequest } = require("ethers");
|
||||||
|
const { refreshBalances } = require("../src/shared/balances");
|
||||||
|
|
||||||
|
const RPC_URL = "https://rpc.example.invalid";
|
||||||
|
const EXPLORER_URL = "https://explorer.example.invalid/api/v2";
|
||||||
|
const FIRST = "0x1111111111111111111111111111111111111111";
|
||||||
|
const SECOND = "0x2222222222222222222222222222222222222222";
|
||||||
|
|
||||||
|
// A token the user tracks, outside the bundled list, at 6 decimals.
|
||||||
|
const TOKEN = "0x7777777777777777777777777777777777777777";
|
||||||
|
const TRACKED = {
|
||||||
|
address: TOKEN,
|
||||||
|
symbol: "TRK",
|
||||||
|
name: "Tracked Token",
|
||||||
|
decimals: 6,
|
||||||
|
};
|
||||||
|
|
||||||
|
// USDC, from the bundled list, which the user does not track.
|
||||||
|
const USDC = "0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48";
|
||||||
|
// Neither on the bundled list nor tracked.
|
||||||
|
const OTHER = "0x8888888888888888888888888888888888888888";
|
||||||
|
|
||||||
|
const ZERO_WORD = "0x" + "0".repeat(64);
|
||||||
|
const BALANCE_OF = "0x70a08231";
|
||||||
|
|
||||||
|
// What balanceOf answers, by token contract and then by holder. A pair that is
|
||||||
|
// not here makes balanceOf fail.
|
||||||
|
let holdings;
|
||||||
|
// What Blockscout answers for every address; null makes the request fail.
|
||||||
|
let explorerRows;
|
||||||
|
let logged;
|
||||||
|
|
||||||
|
// One JSON-RPC answer. A call that is not balanceOf is the ENS reverse lookup,
|
||||||
|
// answered with no resolver, so no name.
|
||||||
|
function reply(req) {
|
||||||
|
const envelope = { jsonrpc: "2.0", id: req.id };
|
||||||
|
if (req.method === "eth_getBalance") {
|
||||||
|
return { ...envelope, result: "0x0" };
|
||||||
|
}
|
||||||
|
if (req.method !== "eth_call") {
|
||||||
|
return {
|
||||||
|
...envelope,
|
||||||
|
error: { code: -32601, message: "method not found" },
|
||||||
|
};
|
||||||
|
}
|
||||||
|
const { to, data } = req.params[0];
|
||||||
|
if (!data.startsWith(BALANCE_OF)) return { ...envelope, result: ZERO_WORD };
|
||||||
|
const holder = "0x" + data.slice(-40);
|
||||||
|
const amount = (holdings[to.toLowerCase()] || {})[holder];
|
||||||
|
if (amount === undefined) {
|
||||||
|
return {
|
||||||
|
...envelope,
|
||||||
|
error: { code: -32000, message: "fixture: balanceOf failed" },
|
||||||
|
};
|
||||||
|
}
|
||||||
|
return {
|
||||||
|
...envelope,
|
||||||
|
result: AbiCoder.defaultAbiCoder().encode(["uint256"], [amount]),
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
const realFetch = globalThis.fetch;
|
||||||
|
|
||||||
|
beforeEach(() => {
|
||||||
|
holdings = {};
|
||||||
|
explorerRows = null;
|
||||||
|
logged = [];
|
||||||
|
jest.spyOn(console, "error").mockImplementation((...args) => {
|
||||||
|
logged.push(args.map(String).join(" "));
|
||||||
|
});
|
||||||
|
FetchRequest.registerGetUrl(async (req) => {
|
||||||
|
const body = JSON.parse(Buffer.from(req.body).toString("utf8"));
|
||||||
|
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)),
|
||||||
|
};
|
||||||
|
});
|
||||||
|
globalThis.fetch = jest.fn(async () => {
|
||||||
|
if (explorerRows === null) throw new TypeError("Failed to fetch");
|
||||||
|
return { ok: true, status: 200, json: async () => explorerRows };
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
afterEach(() => {
|
||||||
|
FetchRequest.registerGetUrl(FetchRequest.createGetUrlFunc());
|
||||||
|
globalThis.fetch = realFetch;
|
||||||
|
jest.restoreAllMocks();
|
||||||
|
});
|
||||||
|
|
||||||
|
// One Blockscout token-balances row.
|
||||||
|
function explorerRow(address, symbol, value, holders = "50000") {
|
||||||
|
return {
|
||||||
|
value: String(value),
|
||||||
|
token: {
|
||||||
|
type: "ERC-20",
|
||||||
|
address_hash: address,
|
||||||
|
symbol: symbol,
|
||||||
|
name: symbol,
|
||||||
|
decimals: "6",
|
||||||
|
holders_count: holders,
|
||||||
|
},
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
// The row refreshBalances() writes for TOKEN from a balanceOf answer, with the
|
||||||
|
// decimals and holder count Blockscout reported for it, if any.
|
||||||
|
function trackedRow(balance, decimals = null, holders = null) {
|
||||||
|
return {
|
||||||
|
address: TOKEN,
|
||||||
|
name: "Tracked Token",
|
||||||
|
symbol: "TRK",
|
||||||
|
decimals: decimals,
|
||||||
|
balance: balance,
|
||||||
|
holders: holders,
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
async function refresh(addresses, trackedTokens) {
|
||||||
|
await refreshBalances(
|
||||||
|
[{ addresses }],
|
||||||
|
RPC_URL,
|
||||||
|
EXPLORER_URL,
|
||||||
|
trackedTokens,
|
||||||
|
"mainnet",
|
||||||
|
new AbortController().signal,
|
||||||
|
);
|
||||||
|
return addresses;
|
||||||
|
}
|
||||||
|
|
||||||
|
test("with Blockscout failing, a tracked token's balance is read through the RPC endpoint for every address", async () => {
|
||||||
|
holdings[TOKEN] = { [FIRST]: 1234500000n, [SECOND]: 1n };
|
||||||
|
const [first, second] = await refresh(
|
||||||
|
[
|
||||||
|
{ address: FIRST, tokenBalances: [] },
|
||||||
|
{ address: SECOND, tokenBalances: [] },
|
||||||
|
],
|
||||||
|
[TRACKED],
|
||||||
|
);
|
||||||
|
expect(first.tokenBalances).toEqual([trackedRow("1234.5")]);
|
||||||
|
// Exact, never cut: one base unit is not zero.
|
||||||
|
expect(second.tokenBalances).toEqual([trackedRow("0.000001")]);
|
||||||
|
});
|
||||||
|
|
||||||
|
test("with Blockscout failing, the untracked rows from before stay", async () => {
|
||||||
|
holdings[TOKEN] = { [FIRST]: 2000000n };
|
||||||
|
const usdc = {
|
||||||
|
address: USDC,
|
||||||
|
name: "USD Coin",
|
||||||
|
symbol: "USDC",
|
||||||
|
decimals: 6,
|
||||||
|
balance: "5.0",
|
||||||
|
holders: 50000,
|
||||||
|
};
|
||||||
|
const [first] = await refresh(
|
||||||
|
[{ address: FIRST, tokenBalances: [usdc] }],
|
||||||
|
[TRACKED],
|
||||||
|
);
|
||||||
|
expect(first.tokenBalances).toEqual([trackedRow("2.0"), usdc]);
|
||||||
|
});
|
||||||
|
|
||||||
|
test("a tracked token Blockscout also reports shows the RPC figure, and an untracked one is admitted as before", async () => {
|
||||||
|
holdings[TOKEN] = { [FIRST]: 2000000n };
|
||||||
|
explorerRows = [
|
||||||
|
explorerRow(TOKEN, "TRK", 9000000),
|
||||||
|
explorerRow(USDC, "USDC", 5000000),
|
||||||
|
// Too few holders, and neither on the bundled list nor tracked.
|
||||||
|
explorerRow(OTHER, "SPAM", 5000000, "10"),
|
||||||
|
// A known symbol from a contract it does not belong to.
|
||||||
|
explorerRow(OTHER, "USDC", 5000000),
|
||||||
|
];
|
||||||
|
const [first] = await refresh(
|
||||||
|
[{ address: FIRST, tokenBalances: [] }],
|
||||||
|
[TRACKED],
|
||||||
|
);
|
||||||
|
expect(first.tokenBalances).toEqual([
|
||||||
|
trackedRow("2.0", 6, 50000),
|
||||||
|
{
|
||||||
|
address: USDC,
|
||||||
|
name: "USDC",
|
||||||
|
symbol: "USDC",
|
||||||
|
decimals: 6,
|
||||||
|
balance: "5.0",
|
||||||
|
holders: 50000,
|
||||||
|
},
|
||||||
|
]);
|
||||||
|
});
|
||||||
|
|
||||||
|
test("a tracked token's entry carries the holder count and decimals Blockscout reports for it", async () => {
|
||||||
|
holdings[TOKEN] = { [FIRST]: 2000000n };
|
||||||
|
// Fewer holders than "Hide tokens with fewer than 1,000 holders" lets
|
||||||
|
// through to Send's token list.
|
||||||
|
explorerRows = [explorerRow(TOKEN, "TRK", 9000000, "10")];
|
||||||
|
const [first] = await refresh(
|
||||||
|
[{ address: FIRST, tokenBalances: [] }],
|
||||||
|
[TRACKED],
|
||||||
|
);
|
||||||
|
expect(first.tokenBalances).toEqual([trackedRow("2.0", 6, 10)]);
|
||||||
|
});
|
||||||
|
|
||||||
|
test("while Blockscout fails, a tracked token keeps the holder count and decimals of its entry from before", async () => {
|
||||||
|
holdings[TOKEN] = { [FIRST]: 2000000n };
|
||||||
|
const [first] = await refresh(
|
||||||
|
[{ address: FIRST, tokenBalances: [trackedRow("7.0", 6, 10)] }],
|
||||||
|
[TRACKED],
|
||||||
|
);
|
||||||
|
expect(first.tokenBalances).toEqual([trackedRow("2.0", 6, 10)]);
|
||||||
|
});
|
||||||
|
|
||||||
|
test("a failed balanceOf keeps the token's entry from before, and is logged", async () => {
|
||||||
|
explorerRows = [explorerRow(TOKEN, "TRK", 9000000)];
|
||||||
|
const before = trackedRow("7.0", 6, 50000);
|
||||||
|
const [first] = await refresh(
|
||||||
|
[{ address: FIRST, tokenBalances: [before] }],
|
||||||
|
[TRACKED],
|
||||||
|
);
|
||||||
|
expect(first.tokenBalances).toEqual([before]);
|
||||||
|
expect(logged.some((line) => line.includes("token balance failed"))).toBe(
|
||||||
|
true,
|
||||||
|
);
|
||||||
|
});
|
||||||
|
|
||||||
|
test("a failed balanceOf with no entry from before takes Blockscout's entry from this refresh", async () => {
|
||||||
|
// balanceOf fails at FIRST and answers at SECOND.
|
||||||
|
holdings[TOKEN] = { [SECOND]: 2000000n };
|
||||||
|
explorerRows = [explorerRow(TOKEN, "TRK", 9000000)];
|
||||||
|
const [first, second] = await refresh(
|
||||||
|
[
|
||||||
|
{ address: FIRST, tokenBalances: [] },
|
||||||
|
{ address: SECOND, tokenBalances: [] },
|
||||||
|
],
|
||||||
|
[TRACKED],
|
||||||
|
);
|
||||||
|
expect(first.tokenBalances).toEqual([
|
||||||
|
{
|
||||||
|
address: TOKEN,
|
||||||
|
name: "TRK",
|
||||||
|
symbol: "TRK",
|
||||||
|
decimals: 6,
|
||||||
|
balance: "9.0",
|
||||||
|
holders: 50000,
|
||||||
|
},
|
||||||
|
]);
|
||||||
|
// Where balanceOf answers, its figure stands.
|
||||||
|
expect(second.tokenBalances).toEqual([trackedRow("2.0", 6, 50000)]);
|
||||||
|
});
|
||||||
|
|
||||||
|
test("a balance of zero read through the RPC endpoint replaces the previous figure", async () => {
|
||||||
|
holdings[TOKEN] = { [FIRST]: 0n };
|
||||||
|
const [first] = await refresh(
|
||||||
|
[{ address: FIRST, tokenBalances: [trackedRow("7.0")] }],
|
||||||
|
[TRACKED],
|
||||||
|
);
|
||||||
|
expect(first.tokenBalances).toEqual([]);
|
||||||
|
});
|
||||||
|
|
||||||
|
test("a tracked token whose scale nothing knows gets no quantity, not a zero", async () => {
|
||||||
|
holdings[TOKEN] = { [FIRST]: 5n };
|
||||||
|
const [first] = await refresh(
|
||||||
|
[{ address: FIRST, tokenBalances: [] }],
|
||||||
|
[{ ...TRACKED, decimals: null }],
|
||||||
|
);
|
||||||
|
expect(first.tokenBalances).toEqual([trackedRow(null)]);
|
||||||
|
});
|
||||||
|
|
||||||
|
test("a tracked token whose scale only Blockscout reports is stated at that scale", async () => {
|
||||||
|
holdings[TOKEN] = { [FIRST]: 2000000n };
|
||||||
|
explorerRows = [explorerRow(TOKEN, "TRK", 9000000)];
|
||||||
|
const [first] = await refresh(
|
||||||
|
[{ address: FIRST, tokenBalances: [] }],
|
||||||
|
[{ ...TRACKED, decimals: null }],
|
||||||
|
);
|
||||||
|
expect(first.tokenBalances).toEqual([trackedRow("2.0", 6, 50000)]);
|
||||||
|
});
|
||||||
|
|
||||||
|
test("a tracked token wearing a known symbol from another contract is not listed", async () => {
|
||||||
|
holdings[OTHER] = { [FIRST]: 5000000n };
|
||||||
|
// Its entry from before goes too, although Blockscout fails.
|
||||||
|
const before = {
|
||||||
|
address: OTHER,
|
||||||
|
name: "Fake",
|
||||||
|
symbol: "USDC",
|
||||||
|
decimals: 6,
|
||||||
|
balance: "5.0",
|
||||||
|
holders: 50000,
|
||||||
|
};
|
||||||
|
const [first] = await refresh(
|
||||||
|
[{ address: FIRST, tokenBalances: [before] }],
|
||||||
|
[{ address: OTHER, symbol: "USDC", name: "Fake", decimals: 6 }],
|
||||||
|
);
|
||||||
|
expect(first.tokenBalances).toEqual([]);
|
||||||
|
});
|
||||||
@@ -161,6 +161,7 @@ test("a token added by contract address on Sepolia is tracked on Sepolia only",
|
|||||||
);
|
);
|
||||||
expect(stored().trackedTokens).toEqual([SEPOLIA_TOKEN]);
|
expect(stored().trackedTokens).toEqual([SEPOLIA_TOKEN]);
|
||||||
|
|
||||||
|
await boot.click("btn-settings");
|
||||||
await chooseNetwork(boot, "mainnet");
|
await chooseNetwork(boot, "mainnet");
|
||||||
expect(stored().networkId).toBe("mainnet");
|
expect(stored().networkId).toBe("mainnet");
|
||||||
expect(stored().trackedTokens).toEqual([MAINNET_TOKEN]);
|
expect(stored().trackedTokens).toEqual([MAINNET_TOKEN]);
|
||||||
|
|||||||
+839
-50
File diff suppressed because it is too large
Load Diff
+419
-25
@@ -11,7 +11,8 @@
|
|||||||
// what each PERMIT2_TRANSFER_FROM moves
|
// what each PERMIT2_TRANSFER_FROM moves
|
||||||
// (https://git.eeqj.de/sneak/AutistMask/issues/611), and when an
|
// (https://git.eeqj.de/sneak/AutistMask/issues/611), and when an
|
||||||
// UNWRAP_WETH makes the output ETH
|
// UNWRAP_WETH makes the output ETH
|
||||||
// (https://git.eeqj.de/sneak/AutistMask/issues/607).
|
// (https://git.eeqj.de/sneak/AutistMask/issues/607 and
|
||||||
|
// https://git.eeqj.de/sneak/AutistMask/issues/642).
|
||||||
//
|
//
|
||||||
// Every swap command, SWEEP, WRAP_ETH, UNWRAP_WETH, TRANSFER, PAY_PORTION,
|
// Every swap command, SWEEP, WRAP_ETH, UNWRAP_WETH, TRANSFER, PAY_PORTION,
|
||||||
// PAY_PORTION_FULL_PRECISION, PERMIT2_TRANSFER_FROM, ACROSS_V4_DEPOSIT_V3 and
|
// PAY_PORTION_FULL_PRECISION, PERMIT2_TRANSFER_FROM, ACROSS_V4_DEPOSIT_V3 and
|
||||||
@@ -745,6 +746,365 @@ describe("an UNWRAP_WETH makes the output ETH only when the router holds it", ()
|
|||||||
});
|
});
|
||||||
});
|
});
|
||||||
|
|
||||||
|
// https://git.eeqj.de/sneak/AutistMask/issues/642: a step between the swap and
|
||||||
|
// the UNWRAP_WETH may take WETH out of the router or pay it WETH, and a step
|
||||||
|
// after an UNWRAP_WETH into the router may pay its ETH out as WETH, yet each
|
||||||
|
// route read as ETH with the swap's minimum. A step the decoder read that is a
|
||||||
|
// PERMIT2_PERMIT, a BALANCE_CHECK_ERC20, or a SWEEP, TRANSFER, PAY_PORTION or
|
||||||
|
// PAY_PORTION_FULL_PRECISION of a token other than WETH, and not of ETH to a
|
||||||
|
// WETH contract, cannot take WETH out of the router or pay anyone WETH; the
|
||||||
|
// decoder treats every other step as one that may.
|
||||||
|
describe("what reaches the UNWRAP_WETH of the swap's WETH", () => {
|
||||||
|
const NO_MINIMUM_TO_USER = PAID_TO_USER.filter(
|
||||||
|
(l) => l !== "Min. received",
|
||||||
|
);
|
||||||
|
const NO_MINIMUM_ELSEWHERE = PAID_ELSEWHERE.filter(
|
||||||
|
(l) => l !== "Min. paid out",
|
||||||
|
);
|
||||||
|
|
||||||
|
test.each([
|
||||||
|
{
|
||||||
|
kind: "a TRANSFER of 0.0025 WETH",
|
||||||
|
step: transfer(0x05, WETH, OTHER, ONE_WETH / 400n),
|
||||||
|
},
|
||||||
|
{
|
||||||
|
kind: "a PAY_PORTION of 25 bips",
|
||||||
|
step: transfer(0x06, WETH, OTHER, 25n),
|
||||||
|
},
|
||||||
|
{
|
||||||
|
kind: "a PAY_PORTION_FULL_PRECISION of 1e15",
|
||||||
|
step: transfer(0x07, WETH, OTHER, 10n ** 15n),
|
||||||
|
},
|
||||||
|
])(
|
||||||
|
"$kind to another address between them reads as ETH with no minimum",
|
||||||
|
({ step }) => {
|
||||||
|
const result = decode(
|
||||||
|
execute(swapToWeth(ADDRESS_THIS), step, unwrapWeth(MSG_SENDER)),
|
||||||
|
USER,
|
||||||
|
ROUTER_V2_1_2,
|
||||||
|
);
|
||||||
|
expect(result.name).toBe("Swap USDT → ETH");
|
||||||
|
expect(labels(result)).toEqual(NO_MINIMUM_ELSEWHERE);
|
||||||
|
expect(paidTo(result)).toEqual([OTHER]);
|
||||||
|
},
|
||||||
|
);
|
||||||
|
|
||||||
|
test.each([
|
||||||
|
{
|
||||||
|
kind: "a SWEEP whose recipient cannot be read",
|
||||||
|
step: withDirtyWord(sweep(WETH, OTHER), 1),
|
||||||
|
},
|
||||||
|
{
|
||||||
|
kind: "a V4 SETTLE of 0.5 WETH from the router",
|
||||||
|
step: v4Swap([
|
||||||
|
0x0b,
|
||||||
|
coder.encode(
|
||||||
|
["address", "uint256", "bool"],
|
||||||
|
[WETH, ONE_WETH / 2n, false],
|
||||||
|
),
|
||||||
|
]),
|
||||||
|
},
|
||||||
|
{
|
||||||
|
kind: "a bridge deposit of 0.5 WETH",
|
||||||
|
step: acrossDeposit(USER, USER, WETH, ONE_WETH / 2n),
|
||||||
|
},
|
||||||
|
{
|
||||||
|
kind: "a PERMIT2_TRANSFER_FROM of 0.5 WETH into the router",
|
||||||
|
step: permit2TransferFrom(WETH, ADDRESS_THIS, ONE_WETH / 2n),
|
||||||
|
},
|
||||||
|
])("$kind between them reads as ETH with no minimum", ({ step }) => {
|
||||||
|
const result = decode(
|
||||||
|
execute(swapToWeth(ADDRESS_THIS), step, unwrapWeth(MSG_SENDER)),
|
||||||
|
);
|
||||||
|
expect(result.name).toBe("Swap USDT → ETH");
|
||||||
|
expect(detail(result, "Min. received")).toBeUndefined();
|
||||||
|
expect(detail(result, "Min. paid out")).toBeUndefined();
|
||||||
|
});
|
||||||
|
|
||||||
|
test.each([
|
||||||
|
{
|
||||||
|
kind: "a PERMIT2_PERMIT between them",
|
||||||
|
steps: [permit2Permit(USDT, USDT_2000), unwrapWeth(MSG_SENDER)],
|
||||||
|
},
|
||||||
|
{
|
||||||
|
kind: "a BALANCE_CHECK_ERC20 of another address between them",
|
||||||
|
steps: [balanceCheck(USDC, 1n, OTHER), unwrapWeth(MSG_SENDER)],
|
||||||
|
},
|
||||||
|
{
|
||||||
|
kind: "a BALANCE_CHECK_ERC20 of the sender with a zero minimum between them",
|
||||||
|
steps: [balanceCheck(USDC, 0n), unwrapWeth(MSG_SENDER)],
|
||||||
|
},
|
||||||
|
{
|
||||||
|
kind: "a SWEEP of USDC between them",
|
||||||
|
steps: [sweep(USDC, MSG_SENDER), unwrapWeth(MSG_SENDER)],
|
||||||
|
},
|
||||||
|
{
|
||||||
|
kind: "an UNWRAP_WETH into the router, then a SWEEP of its ETH,",
|
||||||
|
steps: [unwrapWeth(ADDRESS_THIS), sweep(ZERO, MSG_SENDER)],
|
||||||
|
},
|
||||||
|
])("$kind reads as ETH with the swap's minimum", ({ steps }) => {
|
||||||
|
const result = decode(execute(swapToWeth(ADDRESS_THIS), ...steps));
|
||||||
|
expect(result.name).toBe("Swap USDT → ETH");
|
||||||
|
expect(detail(result, "Min. received").value).toBe("1.0000 ETH");
|
||||||
|
});
|
||||||
|
|
||||||
|
test("a V4 step that TAKEs its WETH to the router, then an UNWRAP_WETH to the user, reads as ETH with the swap's minimum", () => {
|
||||||
|
const result = decode(
|
||||||
|
execute(
|
||||||
|
v4Swap(
|
||||||
|
SWAP_USDT_FOR_WETH,
|
||||||
|
SETTLE_USDT,
|
||||||
|
take(WETH, ADDRESS_THIS),
|
||||||
|
),
|
||||||
|
unwrapWeth(MSG_SENDER),
|
||||||
|
),
|
||||||
|
);
|
||||||
|
expect(result.name).toBe("Swap USDT → ETH");
|
||||||
|
expect(detail(result, "Min. received").value).toBe("1.0000 ETH");
|
||||||
|
});
|
||||||
|
|
||||||
|
test.each([
|
||||||
|
{
|
||||||
|
kind: "a TRANSFER of 100 USDC",
|
||||||
|
step: transfer(0x05, USDC, OTHER, 100000000n),
|
||||||
|
},
|
||||||
|
{
|
||||||
|
kind: "a PAY_PORTION of 25 bips of USDC",
|
||||||
|
step: transfer(0x06, USDC, OTHER, 25n),
|
||||||
|
},
|
||||||
|
{
|
||||||
|
kind: "a PAY_PORTION_FULL_PRECISION of 1e15 of USDC",
|
||||||
|
step: transfer(0x07, USDC, OTHER, 10n ** 15n),
|
||||||
|
},
|
||||||
|
])(
|
||||||
|
"$kind to another address between them reads as ETH with the swap's minimum",
|
||||||
|
({ step }) => {
|
||||||
|
const result = decode(
|
||||||
|
execute(swapToWeth(ADDRESS_THIS), step, unwrapWeth(MSG_SENDER)),
|
||||||
|
USER,
|
||||||
|
ROUTER_V2_1_2,
|
||||||
|
);
|
||||||
|
expect(result.name).toBe("Swap USDT → ETH");
|
||||||
|
expect(paidTo(result)).toEqual([OTHER]);
|
||||||
|
expect(detail(result, "Min. paid out").value).toBe("1.0000 ETH");
|
||||||
|
},
|
||||||
|
);
|
||||||
|
|
||||||
|
test.each([
|
||||||
|
{
|
||||||
|
kind: "a TRANSFER of 0.0025 ETH",
|
||||||
|
step: transfer(0x05, ZERO, OTHER, ONE_WETH / 400n),
|
||||||
|
},
|
||||||
|
{
|
||||||
|
kind: "a PAY_PORTION of 25 bips of its ETH",
|
||||||
|
step: transfer(0x06, ZERO, OTHER, 25n),
|
||||||
|
},
|
||||||
|
{
|
||||||
|
kind: "a PAY_PORTION_FULL_PRECISION of 1e15 of its ETH",
|
||||||
|
step: transfer(0x07, ZERO, OTHER, 10n ** 15n),
|
||||||
|
},
|
||||||
|
])(
|
||||||
|
"an UNWRAP_WETH into the router, then $kind to another address, then a SWEEP of its ETH to the user, reads as ETH with the swap's minimum",
|
||||||
|
({ step }) => {
|
||||||
|
const result = decode(
|
||||||
|
execute(
|
||||||
|
swapToWeth(ADDRESS_THIS),
|
||||||
|
unwrapWeth(ADDRESS_THIS),
|
||||||
|
step,
|
||||||
|
sweep(ZERO, MSG_SENDER),
|
||||||
|
),
|
||||||
|
USER,
|
||||||
|
ROUTER_V2_1_2,
|
||||||
|
);
|
||||||
|
expect(result.name).toBe("Swap USDT → ETH");
|
||||||
|
expect(paidTo(result)).toEqual([OTHER]);
|
||||||
|
expect(detail(result, "Min. paid out").value).toBe("1.0000 ETH");
|
||||||
|
},
|
||||||
|
);
|
||||||
|
|
||||||
|
// The SWEEP pays the user the swap's WETH, so the UNWRAP_WETH unwraps the
|
||||||
|
// WRAP_ETH's.
|
||||||
|
test("a SWEEP of the swap's WETH to the user, then a WRAP_ETH into the router, reads as ETH with no minimum", () => {
|
||||||
|
const result = decode(
|
||||||
|
execute(
|
||||||
|
swapToWeth(ADDRESS_THIS),
|
||||||
|
sweep(WETH, MSG_SENDER),
|
||||||
|
wrapEth(ADDRESS_THIS, ONE_WETH),
|
||||||
|
unwrapWeth(MSG_SENDER),
|
||||||
|
),
|
||||||
|
);
|
||||||
|
expect(result.name).toBe("Swap USDT → ETH");
|
||||||
|
expect(labels(result)).toEqual(NO_MINIMUM_TO_USER);
|
||||||
|
});
|
||||||
|
|
||||||
|
test("an UNWRAP_WETH into the router, then a WRAP_ETH of all its ETH to the user, reads as WETH with no minimum", () => {
|
||||||
|
const result = decode(
|
||||||
|
execute(
|
||||||
|
swapToWeth(ADDRESS_THIS),
|
||||||
|
unwrapWeth(ADDRESS_THIS),
|
||||||
|
wrapEth(MSG_SENDER, CONTRACT_BALANCE),
|
||||||
|
),
|
||||||
|
);
|
||||||
|
expect(result.name).toBe("Swap USDT → WETH");
|
||||||
|
expect(labels(result)).toEqual(NO_MINIMUM_TO_USER);
|
||||||
|
});
|
||||||
|
|
||||||
|
// The router reads the recipient from the last 20 bytes of its word,
|
||||||
|
// here address(2), the router itself.
|
||||||
|
test("an UNWRAP_WETH whose recipient cannot be read, then a WRAP_ETH of all the router's ETH to the user, reads as WETH with no minimum", () => {
|
||||||
|
const result = decode(
|
||||||
|
execute(
|
||||||
|
swapToWeth(ADDRESS_THIS),
|
||||||
|
withDirtyWord(unwrapWeth(ADDRESS_THIS), 0),
|
||||||
|
wrapEth(MSG_SENDER, CONTRACT_BALANCE),
|
||||||
|
),
|
||||||
|
);
|
||||||
|
expect(result.name).toBe("Swap USDT → WETH");
|
||||||
|
expect(detail(result, "Min. received")).toBeUndefined();
|
||||||
|
expect(detail(result, "Min. paid out")).toBeUndefined();
|
||||||
|
});
|
||||||
|
|
||||||
|
// The first UNWRAP_WETH may pay the router the swap's output as ETH, and
|
||||||
|
// the WRAP_ETH to the user pays all of it out as WETH, so the last
|
||||||
|
// UNWRAP_WETH finds none of it.
|
||||||
|
test.each([
|
||||||
|
{
|
||||||
|
kind: "an UNWRAP_WETH whose recipient cannot be read, then a WRAP_ETH of all the router's ETH to the user",
|
||||||
|
steps: [
|
||||||
|
withDirtyWord(unwrapWeth(ADDRESS_THIS), 0),
|
||||||
|
wrapEth(MSG_SENDER, CONTRACT_BALANCE),
|
||||||
|
],
|
||||||
|
},
|
||||||
|
{
|
||||||
|
kind: "an UNWRAP_WETH into the router, a WRAP_ETH of all its ETH to the user, then a WRAP_ETH of all its ETH into the router",
|
||||||
|
steps: [
|
||||||
|
unwrapWeth(ADDRESS_THIS),
|
||||||
|
wrapEth(MSG_SENDER, CONTRACT_BALANCE),
|
||||||
|
wrapEth(ADDRESS_THIS, CONTRACT_BALANCE),
|
||||||
|
],
|
||||||
|
},
|
||||||
|
])(
|
||||||
|
"$kind, then an UNWRAP_WETH to the user, reads as WETH with no minimum",
|
||||||
|
({ steps }) => {
|
||||||
|
const result = decode(
|
||||||
|
execute(
|
||||||
|
swapToWeth(ADDRESS_THIS),
|
||||||
|
...steps,
|
||||||
|
unwrapWeth(MSG_SENDER),
|
||||||
|
),
|
||||||
|
);
|
||||||
|
expect(result.name).toBe("Swap USDT → WETH");
|
||||||
|
expect(detail(result, "Min. received")).toBeUndefined();
|
||||||
|
expect(detail(result, "Min. paid out")).toBeUndefined();
|
||||||
|
},
|
||||||
|
);
|
||||||
|
|
||||||
|
// A SWEEP of WETH pays out WETH, and ETH paid to a WETH contract pays the
|
||||||
|
// router WETH for it. The decoder treats each as a step that may pay out
|
||||||
|
// as WETH the swap's output, which the router holds as ETH.
|
||||||
|
test.each([
|
||||||
|
{
|
||||||
|
kind: "a SWEEP of WETH to the user",
|
||||||
|
step: sweep(WETH, MSG_SENDER),
|
||||||
|
},
|
||||||
|
{
|
||||||
|
kind: "a SWEEP of its ETH to the WETH contract",
|
||||||
|
step: sweep(ZERO, WETH),
|
||||||
|
},
|
||||||
|
{
|
||||||
|
kind: "a TRANSFER of 0.5 ETH to the WETH contract",
|
||||||
|
step: transfer(0x05, ZERO, WETH, ONE_WETH / 2n),
|
||||||
|
},
|
||||||
|
{
|
||||||
|
kind: "a PAY_PORTION of all its ETH to the WETH contract",
|
||||||
|
step: transfer(0x06, ZERO, WETH, 10000n),
|
||||||
|
},
|
||||||
|
])(
|
||||||
|
"an UNWRAP_WETH into the router, then $kind, reads as WETH with no minimum",
|
||||||
|
({ step }) => {
|
||||||
|
const result = decode(
|
||||||
|
execute(
|
||||||
|
swapToWeth(ADDRESS_THIS),
|
||||||
|
unwrapWeth(ADDRESS_THIS),
|
||||||
|
step,
|
||||||
|
),
|
||||||
|
);
|
||||||
|
expect(result.name).toBe("Swap USDT → WETH");
|
||||||
|
expect(detail(result, "Min. received")).toBeUndefined();
|
||||||
|
expect(detail(result, "Min. paid out")).toBeUndefined();
|
||||||
|
},
|
||||||
|
);
|
||||||
|
|
||||||
|
// The user receives 0.5 WETH and the rest of the swap's output as ETH.
|
||||||
|
test("an UNWRAP_WETH into the router, then a WRAP_ETH of 0.5 ETH to the user, reads as WETH with no minimum", () => {
|
||||||
|
const result = decode(
|
||||||
|
execute(
|
||||||
|
swapToWeth(ADDRESS_THIS),
|
||||||
|
unwrapWeth(ADDRESS_THIS),
|
||||||
|
wrapEth(MSG_SENDER, ONE_WETH / 2n),
|
||||||
|
sweep(ZERO, MSG_SENDER),
|
||||||
|
),
|
||||||
|
);
|
||||||
|
expect(result.name).toBe("Swap USDT → WETH");
|
||||||
|
expect(labels(result)).toEqual(NO_MINIMUM_TO_USER);
|
||||||
|
});
|
||||||
|
|
||||||
|
// The UNWRAP_WETH pays the user the swap's WETH as ETH; the WRAP_ETH wraps
|
||||||
|
// the ETH an earlier V4 step paid the router.
|
||||||
|
test("an UNWRAP_WETH to the user, then a WRAP_ETH of all the router's ETH to the user, reads as ETH", () => {
|
||||||
|
const result = decode(
|
||||||
|
execute(
|
||||||
|
v4Swap(
|
||||||
|
SWAP_USDT_FOR_ETH,
|
||||||
|
SETTLE_USDT,
|
||||||
|
take(ZERO, ADDRESS_THIS),
|
||||||
|
),
|
||||||
|
swapToWeth(ADDRESS_THIS),
|
||||||
|
unwrapWeth(MSG_SENDER),
|
||||||
|
wrapEth(MSG_SENDER, CONTRACT_BALANCE),
|
||||||
|
),
|
||||||
|
);
|
||||||
|
expect(detail(result, "Token Out").value).toBe("ETH");
|
||||||
|
expect(detail(result, "Min. received").value).toBe("1.0000 ETH");
|
||||||
|
});
|
||||||
|
|
||||||
|
// The first swap is for at least 0.5 WETH and the second for at least
|
||||||
|
// 1 WETH. The second sets the output side again, so the first
|
||||||
|
// UNWRAP_WETH into the router no longer bears on it.
|
||||||
|
test.each([
|
||||||
|
{ kind: "a V3 swap step", step: swapToWeth(ADDRESS_THIS) },
|
||||||
|
{
|
||||||
|
kind: "a V4 step that TAKEs its WETH to the router",
|
||||||
|
step: v4Swap(
|
||||||
|
SWAP_USDT_FOR_WETH,
|
||||||
|
SETTLE_USDT,
|
||||||
|
take(WETH, ADDRESS_THIS),
|
||||||
|
),
|
||||||
|
},
|
||||||
|
])(
|
||||||
|
"a swap paying WETH to the router, an UNWRAP_WETH into the router, a SWEEP of its ETH to the user, then $kind and an UNWRAP_WETH to the user, reads as ETH with the second swap's minimum",
|
||||||
|
({ step }) => {
|
||||||
|
const result = decode(
|
||||||
|
execute(
|
||||||
|
v3SwapExactIn(
|
||||||
|
ADDRESS_THIS,
|
||||||
|
USDT_2000,
|
||||||
|
ONE_WETH / 2n,
|
||||||
|
USDT,
|
||||||
|
WETH,
|
||||||
|
),
|
||||||
|
unwrapWeth(ADDRESS_THIS),
|
||||||
|
sweep(ZERO, MSG_SENDER),
|
||||||
|
step,
|
||||||
|
unwrapWeth(MSG_SENDER),
|
||||||
|
),
|
||||||
|
);
|
||||||
|
expect(result.name).toBe("Swap USDT → ETH");
|
||||||
|
expect(detail(result, "Min. received").value).toBe("1.0000 ETH");
|
||||||
|
},
|
||||||
|
);
|
||||||
|
});
|
||||||
|
|
||||||
// https://git.eeqj.de/sneak/AutistMask/issues/606: any token a step pays the
|
// https://git.eeqj.de/sneak/AutistMask/issues/606: any token a step pays the
|
||||||
// router stays there unless a later step pays out or spends all of it, not
|
// router stays there unless a later step pays out or spends all of it, not
|
||||||
// only the swap's output. A V4 SETTLE can take more of the user's tokens than
|
// only the swap's output. A V4 SETTLE can take more of the user's tokens than
|
||||||
@@ -972,6 +1332,10 @@ describe("any token left in the router is not received", () => {
|
|||||||
),
|
),
|
||||||
),
|
),
|
||||||
left: tokenLine(WETH, "WETH"),
|
left: tokenLine(WETH, "WETH"),
|
||||||
|
// The second swap action spends 1 USDC of what the first buys,
|
||||||
|
// so the step states no minimum
|
||||||
|
// (https://git.eeqj.de/sneak/AutistMask/issues/574).
|
||||||
|
noMin: true,
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
kind: "a WRAP_ETH of 1 ETH into the router, then a V4 SETTLE of OPEN_DELTA from the router before the swap, which the user settles",
|
kind: "a WRAP_ETH of 1 ETH into the router, then a V4 SETTLE of OPEN_DELTA from the router before the swap, which the user settles",
|
||||||
@@ -1072,15 +1436,24 @@ describe("any token left in the router is not received", () => {
|
|||||||
),
|
),
|
||||||
left: { label: "Token moved into the router", value: "ETH" },
|
left: { label: "Token moved into the router", value: "ETH" },
|
||||||
},
|
},
|
||||||
])("$kind", ({ data, left, spent, unread }) => {
|
])("$kind", ({ data, left, spent, unread, noMin }) => {
|
||||||
const result = decode(data);
|
const result = decode(data);
|
||||||
expect(labels(result)).toEqual([
|
expect(labels(result)).toEqual([
|
||||||
"Protocol",
|
"Protocol",
|
||||||
"Token In",
|
"Token In",
|
||||||
// A later step whose SETTLE or SETTLE_ALL the decoder cannot read
|
// A later step whose SETTLE or SETTLE_ALL the decoder cannot read
|
||||||
// may take anything from the sender: one line says so, in place
|
// may take anything from the sender: one line says so, in place
|
||||||
// of the Amount line (https://git.eeqj.de/sneak/AutistMask/issues/625).
|
// of the Amount line (https://git.eeqj.de/sneak/AutistMask/issues/625),
|
||||||
unread ? "Moved from the sender" : "Amount",
|
// after the lines the WRAP_ETH's 1 ETH then gets
|
||||||
|
// (https://git.eeqj.de/sneak/AutistMask/issues/659).
|
||||||
|
...(unread
|
||||||
|
? [
|
||||||
|
"Moved from the sender",
|
||||||
|
"Token moved",
|
||||||
|
"Moved to",
|
||||||
|
"Moved from the sender",
|
||||||
|
]
|
||||||
|
: ["Amount"]),
|
||||||
// A later swap step the user pays for spends `spent` of a token
|
// A later swap step the user pays for spends `spent` of a token
|
||||||
// other than Token In.
|
// other than Token In.
|
||||||
...(spent
|
...(spent
|
||||||
@@ -1089,7 +1462,7 @@ describe("any token left in the router is not received", () => {
|
|||||||
"Token Out",
|
"Token Out",
|
||||||
"Paid to",
|
"Paid to",
|
||||||
"Token moved into the router",
|
"Token moved into the router",
|
||||||
"Min. paid out",
|
...(noMin ? [] : ["Min. paid out"]),
|
||||||
"Steps",
|
"Steps",
|
||||||
"Deadline",
|
"Deadline",
|
||||||
]);
|
]);
|
||||||
@@ -1097,13 +1470,17 @@ describe("any token left in the router is not received", () => {
|
|||||||
expect(detail(result, "Moved from the sender").value).toBe(spent);
|
expect(detail(result, "Moved from the sender").value).toBe(spent);
|
||||||
}
|
}
|
||||||
if (unread) {
|
if (unread) {
|
||||||
expect(detail(result, "Moved from the sender").value).toBe(
|
expect(
|
||||||
UNDECODED,
|
result.details
|
||||||
);
|
.filter((d) => d.label === "Moved from the sender")
|
||||||
|
.map((d) => d.value),
|
||||||
|
).toEqual(["1.0000 ETH", UNDECODED]);
|
||||||
}
|
}
|
||||||
expect(paidTo(result)).toEqual([STAYS_IN_ROUTER]);
|
expect(paidTo(result)).toEqual([STAYS_IN_ROUTER]);
|
||||||
expect(detail(result, "Token moved into the router")).toEqual(left);
|
expect(detail(result, "Token moved into the router")).toEqual(left);
|
||||||
expect(detail(result, "Min. paid out").value).toBe("1990.0000 USDC");
|
expect(detail(result, "Min. paid out")?.value).toBe(
|
||||||
|
noMin ? undefined : "1990.0000 USDC",
|
||||||
|
);
|
||||||
});
|
});
|
||||||
|
|
||||||
// Uniswap's own routes: a swap paid in ETH wraps into the router what its
|
// Uniswap's own routes: a swap paid in ETH wraps into the router what its
|
||||||
@@ -1711,15 +2088,6 @@ describe("a payout of part of the router's output", () => {
|
|||||||
),
|
),
|
||||||
min: "1.0000 WETH",
|
min: "1.0000 WETH",
|
||||||
},
|
},
|
||||||
{
|
|
||||||
kind: "PAY_PORTION of 25 bips, then UNWRAP_WETH",
|
|
||||||
data: execute(
|
|
||||||
swapToWeth(ADDRESS_THIS),
|
|
||||||
transfer(0x06, WETH, OTHER, 25n),
|
|
||||||
unwrapWeth(MSG_SENDER),
|
|
||||||
),
|
|
||||||
min: "1.0000 ETH",
|
|
||||||
},
|
|
||||||
{
|
{
|
||||||
kind: "V4 TAKE_PORTION of 25 bips, then TAKE_ALL",
|
kind: "V4 TAKE_PORTION of 25 bips, then TAKE_ALL",
|
||||||
data: execute(
|
data: execute(
|
||||||
@@ -2440,26 +2808,37 @@ describe("the allow-revert flag", () => {
|
|||||||
});
|
});
|
||||||
|
|
||||||
// Only the routers from UniversalRouterV2 on let a PERMIT2_PERMIT fail.
|
// Only the routers from UniversalRouterV2 on let a PERMIT2_PERMIT fail.
|
||||||
|
// The permit's spender is the router at ROUTER, which on every other
|
||||||
|
// router is an allowance to another spender, so the minimum reads
|
||||||
|
// Min. paid out there.
|
||||||
test.each([
|
test.each([
|
||||||
{ router: "UniversalRouterV1", address: ROUTER_V1, mark: "" },
|
{
|
||||||
|
router: "UniversalRouterV1",
|
||||||
|
address: ROUTER_V1,
|
||||||
|
mark: "",
|
||||||
|
minimum: "Min. paid out",
|
||||||
|
},
|
||||||
{
|
{
|
||||||
router: "UniversalRouterV1_2_V2Support",
|
router: "UniversalRouterV1_2_V2Support",
|
||||||
address: ROUTER_V1_2,
|
address: ROUTER_V1_2,
|
||||||
mark: "",
|
mark: "",
|
||||||
|
minimum: "Min. paid out",
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
router: "UniversalRouterV2",
|
router: "UniversalRouterV2",
|
||||||
address: ROUTER,
|
address: ROUTER,
|
||||||
mark: " (allowed to fail)",
|
mark: " (allowed to fail)",
|
||||||
|
minimum: "Min. received",
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
router: "UniversalRouterV2_1_2",
|
router: "UniversalRouterV2_1_2",
|
||||||
address: ROUTER_V2_1_2,
|
address: ROUTER_V2_1_2,
|
||||||
mark: " (allowed to fail)",
|
mark: " (allowed to fail)",
|
||||||
|
minimum: "Min. paid out",
|
||||||
},
|
},
|
||||||
])(
|
])(
|
||||||
"on $router, a PERMIT2_PERMIT with the flag is listed as 'Permit2 Permit$mark', and the swap reads as without the flag",
|
"on $router, a PERMIT2_PERMIT with the flag is listed as 'Permit2 Permit$mark', and the swap's lines read as without the flag",
|
||||||
({ address, mark }) => {
|
({ address, mark, minimum }) => {
|
||||||
const steps = [
|
const steps = [
|
||||||
permit2Permit(USDT, USDT_2000),
|
permit2Permit(USDT, USDT_2000),
|
||||||
swapToWeth(MSG_SENDER),
|
swapToWeth(MSG_SENDER),
|
||||||
@@ -2473,10 +2852,25 @@ describe("the allow-revert flag", () => {
|
|||||||
expect(detail(withFlag, "Steps").value).toBe(
|
expect(detail(withFlag, "Steps").value).toBe(
|
||||||
"Permit2 Permit" + mark + " → V3 Swap (Exact In)",
|
"Permit2 Permit" + mark + " → V3 Swap (Exact In)",
|
||||||
);
|
);
|
||||||
const withoutSteps = (r) =>
|
// The permit names the router at ROUTER as its spender, so its
|
||||||
r.details.filter((d) => d.label !== "Steps");
|
// amount stands as the Amount figure only there, and only without
|
||||||
expect(withoutSteps(withFlag)).toEqual(withoutSteps(plain));
|
// the flag. With the flag it stands on no router and gets lines
|
||||||
expect(detail(withFlag, "Min. received").value).toBe("1.0000 WETH");
|
// of its own, and the swap step names Token In: the same token,
|
||||||
|
// its address written the same way.
|
||||||
|
const permitLines = [
|
||||||
|
"Permit2 allowance",
|
||||||
|
"Allowance token",
|
||||||
|
"Allowance spender",
|
||||||
|
];
|
||||||
|
const swapLines = (r) =>
|
||||||
|
r.details.filter(
|
||||||
|
(d) => !["Steps", ...permitLines].includes(d.label),
|
||||||
|
);
|
||||||
|
expect(swapLines(withFlag)).toEqual(swapLines(plain));
|
||||||
|
expect(
|
||||||
|
labels(withFlag).filter((l) => permitLines.includes(l)),
|
||||||
|
).toEqual(permitLines);
|
||||||
|
expect(detail(withFlag, minimum).value).toBe("1.0000 WETH");
|
||||||
},
|
},
|
||||||
);
|
);
|
||||||
|
|
||||||
|
|||||||
@@ -120,7 +120,7 @@ global.document = {
|
|||||||
body: { prepend() {}, appendChild() {} },
|
body: { prepend() {}, appendChild() {} },
|
||||||
addEventListener() {},
|
addEventListener() {},
|
||||||
};
|
};
|
||||||
global.navigator = { clipboard: { writeText() {} } };
|
global.navigator.clipboard = { writeText() {} };
|
||||||
|
|
||||||
const { AbiCoder, parseUnits } = require("ethers");
|
const { AbiCoder, parseUnits } = require("ethers");
|
||||||
const { fetchTokenBalances } = require("../src/shared/balances");
|
const { fetchTokenBalances } = require("../src/shared/balances");
|
||||||
|
|||||||
Reference in New Issue
Block a user