Compare commits
1
Commits
next
..
ff364edd88
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
ff364edd88 |
@@ -500,12 +500,9 @@ papered over:
|
||||
forced by clicking Reveal and the settings gear in one page task, which a
|
||||
person cannot do; the case a person can hit, the first decrypt after the popup
|
||||
opens while libsodium is still loading, is not driven.
|
||||
- Approval windows open at 1280x720 whatever size the extension asks for. The
|
||||
site-connection prompt and the transaction approval are checked for sideways
|
||||
scrolling at 396x600 by sizing the page itself for that measurement only, and
|
||||
the rest of each test runs at 1280x720. That leaves out the window's frame and
|
||||
the page widening its window, so whether an approval screen fits its window is
|
||||
checked in the Firefox suite only.
|
||||
- Approval windows open at 1280x720 whatever size the extension asks for, so
|
||||
whether an approval screen fits its window is checked in the Firefox suite
|
||||
only.
|
||||
|
||||
Any test that drives a failure path on purpose declares the `console.error` it
|
||||
is about to provoke, via `errors.expect()`. That is not a mute: the declaration
|
||||
@@ -1129,15 +1126,13 @@ scale is not an approximation but a different number — 1,000 units of a
|
||||
6-decimal token formatted at 18 decimals reads `0.000000001` — on the screen
|
||||
whose only job is to state what is being authorized. Both amount paths of that
|
||||
screen take this rule: the ERC-20 `transfer`/`approve` line
|
||||
(`src/popup/views/approval.js`) and the swap's `Amount`, `Min. received`,
|
||||
`Moved from the sender` and `Permit2 allowance` lines and the `Paid to` line of
|
||||
a move into the router (`src/shared/uniswap.js`). The token permission warning
|
||||
on the signature screen takes the same rule for its amounts. An unbounded
|
||||
allowance or permit needs no scale to describe and is still shown as
|
||||
`Unlimited`. A source's answer counts only if it is a whole number from 0 to 80:
|
||||
`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.
|
||||
(`src/popup/views/approval.js`) and the swap's `Amount` and `Min. received`
|
||||
lines (`src/shared/uniswap.js`). The token permission warning on the signature
|
||||
screen takes the same rule for its amounts. An unbounded allowance or permit
|
||||
needs no scale to describe and is still shown as `Unlimited`. A source's answer
|
||||
counts only if it is a whole number from 0 to 80: `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
|
||||
sources are read as authoritative, so a value written into one of them cannot be
|
||||
@@ -1181,22 +1176,28 @@ number. They can read:
|
||||
- `Unlimited`: on the ERC-20 `Amount` line, an `approve` of the `uint256`
|
||||
maximum, an unbounded allowance. On the swap's `Amount` line, any amount at or
|
||||
above the `uint160` maximum, whichever step set the line: a `PERMIT2_PERMIT`
|
||||
amount at that maximum, which is an unbounded permit, or a V2 or V3 exact-in
|
||||
or exact-out or `WRAP_ETH` amount that large, which is not an allowance. The
|
||||
amount at that maximum, which is an unbounded permit, or a V2 or V3 exact-in,
|
||||
V2 exact-out or `WRAP_ETH` amount that large, which is not an allowance. The
|
||||
router's whole-balance value, `CONTRACT_BALANCE` (`2^255`), is one such
|
||||
amount.
|
||||
- `Up to <amount>`: the swap's `Amount` line, when the transaction has a V2 or
|
||||
V3 exact-out step, whichever step set the line, including the `WRAP_ETH` of a
|
||||
- `Up to <amount>`: the swap's `Amount` line, when the transaction has a V2
|
||||
exact-out step, whichever step set the line, including the `WRAP_ETH` of a
|
||||
swap paid in ETH and a `PERMIT2_PERMIT`. The swap spends at most that figure,
|
||||
not necessarily all of it; the wait, success and error screens show it with
|
||||
the same words. `Unlimited`, `All available (V4 open delta)` and
|
||||
`Whatever an earlier step sent to the pair (V2 already paid)` keep their
|
||||
wording. When a V2 or V3 exact-out step sets `Min. received`, that line shows
|
||||
its `amountOut`, the exact amount it buys.
|
||||
wording. When a V2 exact-out step sets `Min. received`, that line shows its
|
||||
`amountOut`, the exact amount it buys.
|
||||
- `All available (V4 open delta)`: the swap's `Amount` line, when the amount it
|
||||
shows is a V4 exact-in `amountIn` of zero. V4 reads that zero as "use the
|
||||
whole open delta", so the calldata states no quantity. Transaction Decoding
|
||||
below gives the steps whose amounts the line shows.
|
||||
whole open delta", so the calldata states no quantity. The line shows the
|
||||
amount of the step that sets the input side: the last `PERMIT2_PERMIT` step if
|
||||
there is one, otherwise the first V2 or V3 exact-in, V2 exact-out, `WRAP_ETH`
|
||||
or V4 swap step that names an input token or amount. A V4 step with a swap
|
||||
action sets the input side when no earlier step set it, even when it names
|
||||
neither, as described below. A V2 exact-out step gives its `amountInMax`, and
|
||||
a V4 swap step the `amountIn` of the swap action that spends its input
|
||||
currency.
|
||||
- `Whatever an earlier step sent to the pair (V2 already paid)`: the swap's
|
||||
`Amount` line, when the amount it shows is a V2 exact-in `amountIn` of zero.
|
||||
The router reads that zero as "the pair already holds the input tokens": the
|
||||
@@ -1246,40 +1247,12 @@ only when no earlier step set it. It finds each side by three rules:
|
||||
`Amount` or `Min. received`. A side they did not name is unknown, and the
|
||||
step sets it as unknown with no figure.
|
||||
|
||||
Under each of these rules, when the user pays the step any of the input
|
||||
currency, its `Amount` is instead what the user pays it of that currency when
|
||||
the decoder knows that amount, and otherwise there is none (see Transaction
|
||||
Decoding). So a step whose USDT-for-USDC swap action could not be read, with a
|
||||
`SETTLE` of 400 USDT paid by the user, reads `Amount 400.0000 USDT`.
|
||||
|
||||
A V4 step with no swap action sets only the sides its `SETTLE`, `SETTLE_ALL`,
|
||||
`TAKE` or `TAKE_ALL` names.
|
||||
|
||||
An `UNWRAP_WETH` step makes `Token Out` ETH only when no step set the output
|
||||
side, or when the output side is WETH, on mainnet or Sepolia, that the step that
|
||||
set it paid to the router and that the router still holds when the `UNWRAP_WETH`
|
||||
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
|
||||
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
|
||||
minimum reads in ETH only when that step paid all its WETH to the router and
|
||||
every step between it and the `UNWRAP_WETH` is one the decoder read of these: a
|
||||
`PERMIT2_PERMIT`, a `BALANCE_CHECK_ERC20`, or a `SWEEP`, `TRANSFER`,
|
||||
`PAY_PORTION` or `PAY_PORTION_FULL_PRECISION` of a token other than WETH, but
|
||||
not of ETH to a WETH contract, which pays the router WETH. None of these can
|
||||
take WETH out of the router or pay anyone WETH; the decoder treats every other
|
||||
step as one that may. Otherwise the swap shows ETH with no minimum, as it does
|
||||
after a V4 step that `TAKE`s some of its WETH to the user and the rest to the
|
||||
router, or that pays the router WETH beside a payout the decoder cannot read,
|
||||
and with a WETH interface fee paid by `PAY_PORTION` before the `UNWRAP_WETH`:
|
||||
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
|
||||
An `UNWRAP_WETH` step makes `Token Out` ETH only when the output side is WETH,
|
||||
on mainnet or Sepolia, or when no step set the output side; a WETH
|
||||
`Min. received` figure then reads in ETH. 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
|
||||
@@ -1403,19 +1376,6 @@ carries a `schemaVersion` — `STATE_SCHEMA_VERSION` in
|
||||
`saveState()` and the background's `updateState()` both do, so whichever context
|
||||
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
|
||||
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
|
||||
@@ -2026,11 +1986,7 @@ view would leave a wallet one click from deletion.
|
||||
- Type: transaction classification — one of: Native ETH Transfer, ERC-20
|
||||
Token Transfer, Swap, Token Approval, Contract Call, Contract Creation. A
|
||||
transfer with a token contract is an ERC-20 Token Transfer whatever symbol
|
||||
the token reports. A call named `execute` or `multicall` is a Swap, here
|
||||
and on its history row, only when it was sent to one of the Universal
|
||||
Router addresses Uniswap publishes for the network it was sent on (see
|
||||
Transaction Decoding); sent to any other contract, its history row shows
|
||||
the method name and this line reads Contract Call.
|
||||
the token reports.
|
||||
- Status: "Success" or "Failed"
|
||||
- From: blockie + color dot + full address (tap to copy) + etherscan link;
|
||||
ENS name if available
|
||||
@@ -2094,11 +2050,8 @@ view would leave a wallet one click from deletion.
|
||||
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
|
||||
network it was added on, because a contract address names a token on one
|
||||
network only. Switching also clears every address's balances. A balance
|
||||
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
|
||||
network only. Choosing the network already active changes nothing and
|
||||
sends nothing
|
||||
- Ethereum RPC: endpoint URL input + "Save" button (validated against
|
||||
`eth_chainId` before being saved)
|
||||
- Blockscout API: endpoint URL input + "Save" button (validated against
|
||||
@@ -2426,12 +2379,10 @@ view would leave a wallet one click from deletion.
|
||||
- Site origin (bold, scheme and port included) + "wants to send a
|
||||
transaction"
|
||||
- Decoded action (if calldata is recognized): action name, token details,
|
||||
amounts, what each swap step spends that the `Amount` line does not give,
|
||||
what each `PERMIT2_TRANSFER_FROM` moves and where to, what each
|
||||
`PERMIT2_PERMIT` whose amount is not the `Amount` figure lets its spender
|
||||
take, steps, deadline, and unless 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)
|
||||
amounts, what each `PERMIT2_TRANSFER_FROM` moves and where to, steps,
|
||||
deadline, and unless 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
|
||||
- Contract: color dot + full address + etherscan link, token symbol label if
|
||||
known; for a contract creation, the same sentence as on WaitTx
|
||||
@@ -2445,10 +2396,7 @@ view would leave a wallet one click from deletion.
|
||||
- Password input and an error line
|
||||
- "Confirm" / "Reject" buttons
|
||||
- **Behavior**: Every etherscan link on the screen opens the explorer of the
|
||||
network the transaction was populated on, whichever network is active. The
|
||||
Value and Network fee lines each give the USD value of the exact amount at the
|
||||
price on that network, as on ConfirmTx: none for a testnet transaction or one
|
||||
on a chain id that names no network.
|
||||
network the transaction was populated on, whichever network is active.
|
||||
- **Transitions**:
|
||||
- "Confirm" (correct password) → decrypts and signs the transaction it was
|
||||
shown, exactly as shown, hands the signed transaction to the background to
|
||||
@@ -3059,35 +3007,29 @@ Currently supported:
|
||||
Router addresses Uniswap publishes for the network: on TxApproval the network
|
||||
the transaction is for, on TransactionDetail the network it was sent on. The
|
||||
same calldata sent to any other address is shown as raw data. Decodes Permit2,
|
||||
V2/V3/V4 swaps, wrap/unwrap, and balance checks. A V3 swap step's path is read
|
||||
as the router reads it: a `V3_SWAP_EXACT_IN` path runs from the token it
|
||||
spends to the token it buys, and a `V3_SWAP_EXACT_OUT` path from the token it
|
||||
buys to the token it spends, so that step's input token is its path's last
|
||||
token and its output token the first. The router reads a path as one token
|
||||
address followed by whole hops of a 3-byte fee and a token address, and
|
||||
ignores any bytes after the last hop, so the decoder does not read a path with
|
||||
such bytes. A V4 swap action is read only in the parameter shape deployed on
|
||||
mainnet and Sepolia, not in the newer one on `v4-periphery` `main`, which adds
|
||||
a `minHopPriceX36` field. An action in any other shape is not read, and its
|
||||
step is listed as `V4 Swap (could not be decoded)`. Each step is named and
|
||||
read as the command that the release of the router at that address runs for
|
||||
its command type, as that release's `contracts/libraries/Commands.sol` names
|
||||
it. The decoder reads the type from the command byte with the mask that router
|
||||
uses: `0x1f` for `UniversalRouterV1`, `0x3f` for
|
||||
`UniversalRouterV1_2_V2Support` and `UniversalRouterV2`, and `0x7f` for
|
||||
`UniversalRouterV2_1_1` and `UniversalRouterV2_1_2`. The allow-revert flag
|
||||
(`0x80`) therefore does not change the command a step is read as. Releases run
|
||||
different commands for some types: on `UniversalRouterV1` and
|
||||
`UniversalRouterV1_2_V2Support`, `0x10` to `0x13` are NFT commands, where the
|
||||
later routers run `V4_SWAP`, `V3_POSITION_MANAGER_PERMIT`,
|
||||
`V3_POSITION_MANAGER_CALL` and `V4_INITIALIZE_POOL`. The decoder does not read
|
||||
those routers' NFT commands, and lists each by its name there, for example
|
||||
`Seaport` for `SEAPORT` (`0x10` on `UniversalRouterV1`). A type a release
|
||||
names no command for is listed by its number, for example `Command 0x0e` on
|
||||
`UniversalRouterV1`, which has no `BALANCE_CHECK_ERC20` and reverts on it. The
|
||||
router reverts the whole transaction when a step fails, unless the step's
|
||||
command byte has that flag set and its command is one the router lets fail, as
|
||||
each release's `contracts/base/Dispatcher.sol` shows: on `UniversalRouterV2`,
|
||||
V2/V3/V4 swaps, wrap/unwrap, and balance checks. A V4 swap action is read only
|
||||
in the parameter shape deployed on mainnet and Sepolia, not in the newer one
|
||||
on `v4-periphery` `main`, which adds a `minHopPriceX36` field. An action in
|
||||
any other shape is not read, and its step is listed as
|
||||
`V4 Swap (could not be decoded)`. Each step is named and read as the command
|
||||
that the release of the router at that address runs for its command type, as
|
||||
that release's `contracts/libraries/Commands.sol` names it. The decoder reads
|
||||
the type from the command byte with the mask that router uses: `0x1f` for
|
||||
`UniversalRouterV1`, `0x3f` for `UniversalRouterV1_2_V2Support` and
|
||||
`UniversalRouterV2`, and `0x7f` for `UniversalRouterV2_1_1` and
|
||||
`UniversalRouterV2_1_2`. The allow-revert flag (`0x80`) therefore does not
|
||||
change the command a step is read as. Releases run different commands for some
|
||||
types: on `UniversalRouterV1` and `UniversalRouterV1_2_V2Support`, `0x10` to
|
||||
`0x13` are NFT commands, where the later routers run `V4_SWAP`,
|
||||
`V3_POSITION_MANAGER_PERMIT`, `V3_POSITION_MANAGER_CALL` and
|
||||
`V4_INITIALIZE_POOL`. The decoder does not read those routers' NFT commands,
|
||||
and lists each by its name there, for example `Seaport` for `SEAPORT` (`0x10`
|
||||
on `UniversalRouterV1`). A type a release names no command for is listed by
|
||||
its number, for example `Command 0x0e` on `UniversalRouterV1`, which has no
|
||||
`BALANCE_CHECK_ERC20` and reverts on it. The router reverts the whole
|
||||
transaction when a step fails, unless the step's command byte has that flag
|
||||
set and its command is one the router lets fail, as each release's
|
||||
`contracts/base/Dispatcher.sol` shows: on `UniversalRouterV2`,
|
||||
`UniversalRouterV2_1_1` and `UniversalRouterV2_1_2`, `PERMIT2_PERMIT`,
|
||||
`PERMIT2_PERMIT_BATCH`, `BALANCE_CHECK_ERC20`, `V3_POSITION_MANAGER_PERMIT`,
|
||||
`V3_POSITION_MANAGER_CALL`, `V4_INITIALIZE_POOL`, `V4_POSITION_MANAGER_CALL`
|
||||
@@ -3150,40 +3092,35 @@ Currently supported:
|
||||
as a swap paid in ETH does, but only when that amount is not
|
||||
`CONTRACT_BALANCE` and the router held no WETH from an earlier step when the
|
||||
`WRAP_ETH` ran: after two `WRAP_ETH`s of 0.5 ETH into the router, a swap of 1
|
||||
WETH from it reads as leaving the WETH there. A V2 or V3 exact-out step paid
|
||||
from the router spends an amount the calldata does not state, at most its
|
||||
`amountInMax`, so the decoder counts it as spending nothing the router holds.
|
||||
A `SETTLE` of `OPEN_DELTA` (zero), and a `SETTLE_ALL`, pay only what the step
|
||||
still owes of their token when they run. The decoder takes that to be the
|
||||
amounts the step's swap actions state they spend of that token only when every
|
||||
action in the step could be read, every swap action names the token it spends
|
||||
and the token it buys (a swap action with an empty path swaps nothing), the
|
||||
`SETTLE` or `SETTLE_ALL` is the step's only `SETTLE` or `SETTLE_ALL` of that
|
||||
token and comes after every swap action, no swap action buys that token, no
|
||||
`TAKE`, `TAKE_ALL` or `TAKE_PORTION` in the step takes it (a `TAKE` of a
|
||||
stated amount adds to what the step owes), and the swap actions that spend it
|
||||
state a quantity together; otherwise it does not know the amount, and such a
|
||||
`SETTLE` from the router counts as spending nothing. So the rest of a V4
|
||||
`SETTLE` of more than its swap spends, taken to the router, the WETH of a
|
||||
`WRAP_ETH`, and a token a swap pays the router on the way to the output, each
|
||||
stays in the router when later steps do not spend all of it, where anyone can
|
||||
take it in a later transaction. The router sends ETH as written, so a
|
||||
`TRANSFER` of `CONTRACT_BALANCE` of ETH always reverts and pays out nothing. A
|
||||
step paying a token to the V2 pair that the very next step spends, as a V2
|
||||
exact-in of that token whose `amountIn` is `ALREADY_PAID` (zero) or
|
||||
`CONTRACT_BALANCE`, is a hop, not a payout: Uniswap's mixed routes pay the
|
||||
next V2 pair directly, and the router enforces that swap's own minimum. The
|
||||
decoder checks that the address paid is that pair, deriving it from the V2
|
||||
factory and pair init code hash the network's routers were deployed with and
|
||||
the first two tokens of that step's path; a payment to any other address is
|
||||
named. (Sepolia's `UniversalRouterV1_2_V2Support` was deployed with
|
||||
placeholders for both values, so no V2 swap step can succeed on that router.)
|
||||
Every other payment counts, in whichever step and of whatever token, a share
|
||||
of the output included: an interface fee paid to another address by
|
||||
`PAY_PORTION`, `TRANSFER` or `TAKE_PORTION` is named, and the minimum reads
|
||||
`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
|
||||
From address on TxApproval, the sender the explorer reports on
|
||||
WETH from it reads as leaving the WETH there. The router pays a `SETTLE` of
|
||||
`OPEN_DELTA` (zero) only what its step still owes of that token when the
|
||||
`SETTLE` runs, so one from the router counts as spending the amounts the
|
||||
step's swap actions state they spend of that token only when every action in
|
||||
the step could be read, every swap action names the token it spends and the
|
||||
token it buys (a swap action with an empty path swaps nothing), the `SETTLE`
|
||||
is the step's only `SETTLE` or `SETTLE_ALL` of that token and comes after
|
||||
every swap action, no swap action buys that token, and the swap actions that
|
||||
spend it state a quantity together; otherwise it counts as spending nothing.
|
||||
So the rest of a V4 `SETTLE` of more than its swap spends, taken to the
|
||||
router, the WETH of a `WRAP_ETH`, and a token a swap pays the router on the
|
||||
way to the output, each stays in the router when later steps do not spend all
|
||||
of it, where anyone can take it in a later transaction. The router sends ETH
|
||||
as written, so a `TRANSFER` of `CONTRACT_BALANCE` of ETH always reverts and
|
||||
pays out nothing. A step paying a token to the V2 pair that the very next step
|
||||
spends, as a V2 exact-in of that token whose `amountIn` is `ALREADY_PAID`
|
||||
(zero) or `CONTRACT_BALANCE`, is a hop, not a payout: Uniswap's mixed routes
|
||||
pay the next V2 pair directly, and the router enforces that swap's own
|
||||
minimum. The decoder checks that the address paid is that pair, deriving it
|
||||
from the V2 factory and pair init code hash the network's routers were
|
||||
deployed with and the first two tokens of that step's path; a payment to any
|
||||
other address is named. (Sepolia's `UniversalRouterV1_2_V2Support` was
|
||||
deployed with placeholders for both values, so no V2 swap step can succeed on
|
||||
that router.) Every other payment counts, in whichever step and of whatever
|
||||
token, a share of the output included: an interface fee paid to another
|
||||
address by `PAY_PORTION`, `TRANSFER` or `TAKE_PORTION` is named, and the
|
||||
minimum reads `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 From address on TxApproval, the sender the explorer reports on
|
||||
TransactionDetail) and no `Paid to` line is shown. `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
|
||||
@@ -3197,104 +3134,24 @@ Currently supported:
|
||||
name); and one more reads `Unknown (could not be decoded)` when a step that
|
||||
may pay an address went unread. When no step pays anyone, a single line reads
|
||||
`Unknown (not named in the calldata)`. Wherever there is a `Paid to` line, the
|
||||
minimum reads `Min. paid out`. The `Amount` line gives the total the steps
|
||||
take of `Token In`, from the step that sets the input side on: the first V2 or
|
||||
V3 exact-in or exact-out, `WRAP_ETH` or V4 swap step that names an input token
|
||||
or amount. A V4 step with a swap action sets the input side when no earlier
|
||||
step set it, even when it names neither (see Display Consistency). That step
|
||||
counts its own amount, whoever pays it: a V2 or V3 exact-out step its
|
||||
`amountInMax`, and a V4 step what it takes of its input token from the user's
|
||||
wallet, as below, or, when the user pays it none of that token, the `amountIn`
|
||||
of the swap action that spends it. Each later V2 or V3 exact-in or exact-out
|
||||
step whose `payerIsUser` is true takes its amount, found in the same way, from
|
||||
the user's wallet. Every V4 step, with a swap action or without, takes from
|
||||
the user's wallet what its `SETTLE`s paid by the user (`payerIsUser` true) and
|
||||
its `SETTLE_ALL`s pay, for each token on its own; what the step that sets the
|
||||
input side takes of any other token counts as a later step's take. A `SETTLE`
|
||||
of any amount but `OPEN_DELTA` pays that amount, and a `SETTLE` of
|
||||
`OPEN_DELTA` or a `SETTLE_ALL` pays what the step owes, as above. So a V4 step
|
||||
that swaps 400 USDT, with a `SETTLE` of 5,000 USDT paid by the user and the
|
||||
rest taken to another address, reads `5000.0000 USDT`. A later step paid from
|
||||
the router spends what the router holds and takes nothing, and so does a V2
|
||||
exact-in whose `amountIn` is `ALREADY_PAID`. A later take of `Token In` is
|
||||
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
|
||||
the decoder does not know a take's amount, the total is not known and there is
|
||||
no `Amount` line. A `PERMIT2_PERMIT` names `Token In` only when its amount,
|
||||
`Unlimited` included, stands as the `Amount` figure in place of the total,
|
||||
which it does only in the plain shape of Uniswap's own routes: it comes before
|
||||
the step that sets the input side, it is the only `PERMIT2_PERMIT` in the
|
||||
transaction, its spender is the router, the router may not let it fail, no
|
||||
step before it takes its token or a token the decoder does not know, and the
|
||||
decoder reads every step after it in full. Permit2 then lets the router take
|
||||
no more of the token than that amount, so the permit covers every take of it.
|
||||
A step the decoder does not read in full may raise what Permit2 lets the
|
||||
router take, as a `PERMIT2_PERMIT_BATCH` can: a command the decoder does not
|
||||
read (listed at the end of this section), a step whose input it cannot read,
|
||||
in whole or in part, and a step it fails on. Every other `PERMIT2_PERMIT`,
|
||||
before the step that sets the input side or after it, leaves `Token In` and
|
||||
the `Amount` line as they read with no permit: a permit of 5,000 DAI to
|
||||
another address and then a V3 exact-in of 600 USDT read `Swap USDT → USDC`
|
||||
with `Amount 600.0000 USDT`, and so do that exact-in and then a permit of
|
||||
5,000 DAI to the router. When a permit's amount stands and the step that sets
|
||||
the input side spends a token other than the permit's, or one the decoder does
|
||||
not know, that step's amount gets lines of its own, unless it states no amount
|
||||
and the user pays it none of its input token. Each take the total does not
|
||||
count gives three lines after the `Amount` line (after `Token In` when there
|
||||
is none): one of a token other than `Token In`; one of `Token In` after an
|
||||
amount that is not a quantity (a V4 open delta, `ALREADY_PAID`, which keep
|
||||
their wording on the `Amount` line, or no stated amount, as of a V4 exact-out
|
||||
step); and one whose amount the decoder does not know. 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, the step that sets the input side first when
|
||||
it has them: `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; `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
|
||||
does not know gives the `Moved from the sender` line alone. A step may also
|
||||
take from the user's wallet what the decoder did not read: a V4 step whose
|
||||
input or one of whose `SETTLE`s or `SETTLE_ALL`s it cannot read, which the
|
||||
router still runs; a V2 or V3 exact-in or exact-out step or a
|
||||
`PERMIT2_TRANSFER_FROM` whose input it cannot read, such as a V3 step whose
|
||||
path is shorter than one token address or has bytes after its last hop; every
|
||||
`PERMIT2_TRANSFER_FROM_BATCH`; every `EXECUTE_SUB_PLAN`, wherever it stands;
|
||||
and every step it fails on. Each such step gives one `Moved from the sender`
|
||||
line among those, reading `Unknown (could not be decoded)`. That line, or any
|
||||
line for a token the decoder does not know, leaves no `Amount` line, whose
|
||||
figure might be too low, and such a step before a `PERMIT2_PERMIT` keeps the
|
||||
permit's amount from standing. Then each `PERMIT2_TRANSFER_FROM` but one into
|
||||
the router, in step order, gives three lines: `Moved from the sender`, the
|
||||
amount it moves, for example `1000000.0000 USDT`; `Token moved`, giving the
|
||||
token's address as the `Token In` line does; and `Moved to`, which reads
|
||||
minimum reads `Min. paid out`. After the `Amount` line (after `Token In` when
|
||||
there is none), each `PERMIT2_TRANSFER_FROM` but one into the router, in step
|
||||
order, gives three lines: `Moved from the sender`, the amount it moves, for
|
||||
example `1000000.0000 USDT`; `Token moved`, giving the token's address as the
|
||||
`Token In` line does; and `Moved to`, which reads
|
||||
`The V2 pair the next swap spends` for a hop and `The sender` for `address(1)`
|
||||
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
|
||||
`Token moved into the router` line already give the amount, the token and
|
||||
where it goes, and so its amount is shown once. Every `PERMIT2_PERMIT` whose
|
||||
amount does not stand as the `Amount` figure, before the step that sets the
|
||||
input side or after it, gives three lines, in step order, after those for each
|
||||
`PERMIT2_TRANSFER_FROM`: `Permit2 allowance`, its amount, for example
|
||||
`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. These lines change neither the `Paid to`
|
||||
lines nor the minimum's label. 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_TRANSFER_FROM`, `V2_SWAP_EXACT_IN`, `V2_SWAP_EXACT_OUT`,
|
||||
`V3_SWAP_EXACT_IN`, `V3_SWAP_EXACT_OUT`, `V4_SWAP`, `SWEEP`, `TRANSFER`,
|
||||
`PAY_PORTION`, `PAY_PORTION_FULL_PRECISION`, `ACROSS_V4_DEPOSIT_V3`,
|
||||
`WRAP_ETH`, `UNWRAP_WETH` and `BALANCE_CHECK_ERC20`
|
||||
(`PERMIT2_TRANSFER_FROM_BATCH`, `EXECUTE_SUB_PLAN` and the NFT commands among
|
||||
them), or a type its release names no command for.
|
||||
where it goes, and so its amount is shown once. These lines change neither the
|
||||
`Paid to` lines nor the minimum's label. A step goes unread when its recipient
|
||||
does not decode as an address, or when it is a command the decoder does not
|
||||
read: every command other than `PERMIT2_PERMIT`, `PERMIT2_TRANSFER_FROM`,
|
||||
`V2_SWAP_EXACT_IN`, `V2_SWAP_EXACT_OUT`, `V3_SWAP_EXACT_IN`, `V4_SWAP`,
|
||||
`SWEEP`, `TRANSFER`, `PAY_PORTION`, `PAY_PORTION_FULL_PRECISION`,
|
||||
`ACROSS_V4_DEPOSIT_V3`, `WRAP_ETH`, `UNWRAP_WETH` and `BALANCE_CHECK_ERC20`
|
||||
(`V3_SWAP_EXACT_OUT`, `PERMIT2_TRANSFER_FROM_BATCH`, `EXECUTE_SUB_PLAN` and
|
||||
the NFT commands among them), or a type its release names no command for.
|
||||
|
||||
### Non-Goals Forever
|
||||
|
||||
|
||||
@@ -13,11 +13,6 @@
|
||||
"fmt": "prettier --write .",
|
||||
"fmt-check": "prettier --check ."
|
||||
},
|
||||
"jest": {
|
||||
"setupFiles": [
|
||||
"<rootDir>/tests/support/navigatorLocks.js"
|
||||
]
|
||||
},
|
||||
"devDependencies": {
|
||||
"@eslint/js": "10.0.1",
|
||||
"@tailwindcss/cli": "4.3.1",
|
||||
|
||||
@@ -1379,13 +1379,6 @@ const RECENT_BALANCE_REFRESH_MS = Math.floor(BALANCE_REFRESH_PERIOD_MS / 2);
|
||||
// balances that came back — by address, onto whatever storage holds NOW.
|
||||
// Applying by address rather than writing the array back is what keeps a
|
||||
// wallet or address added, renamed or deleted during the round trip.
|
||||
//
|
||||
// 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() {
|
||||
const s = await getState();
|
||||
const now = Date.now();
|
||||
@@ -1409,7 +1402,6 @@ async function backgroundRefresh() {
|
||||
}
|
||||
|
||||
await updateState((fresh) => {
|
||||
if (fresh.networkId !== s.networkId) return;
|
||||
for (const wallet of fresh.wallets) {
|
||||
for (const addr of wallet.addresses || []) {
|
||||
const got = refreshed.get(String(addr.address).toLowerCase());
|
||||
|
||||
+26
-19
@@ -16,20 +16,17 @@
|
||||
// across any number of awaits and no concurrent work can
|
||||
// move it.
|
||||
// updateState(fn) read fresh, apply fn to that fresh record, write it
|
||||
// back — all holding the lock every write of the stored
|
||||
// record takes, so no other write lands in between, by
|
||||
// the background or by any page except a page in 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
|
||||
// back — all inside a queue, so two background writes
|
||||
// never interleave, and the read is one storage round trip
|
||||
// ahead of the write rather than a page lifetime ahead of
|
||||
// it (which is what made the popup's saveState() need a
|
||||
// per-field merge against a baseline at all).
|
||||
//
|
||||
// A handler that must both read and write therefore does its network work
|
||||
// against a snapshot it owns, and applies the RESULT inside updateState().
|
||||
// It never publishes an object other in-flight work is holding.
|
||||
|
||||
const { storageGet, storageSet, withLock } = require("../shared/browserApi");
|
||||
const { storageGet, storageSet } = require("../shared/browserApi");
|
||||
const { normalizePersisted } = require("../shared/persistedState");
|
||||
const {
|
||||
STATE_SCHEMA_VERSION,
|
||||
@@ -54,6 +51,11 @@ async function getState() {
|
||||
return normalizePersisted(result.autistmask);
|
||||
}
|
||||
|
||||
// Serializes the read-modify-write turns below. Two of them interleaved would
|
||||
// each read before the other wrote, and the second write would carry the first
|
||||
// one's fields back to their pre-turn values.
|
||||
let updateQueue = Promise.resolve();
|
||||
|
||||
async function updateStateOnce(mutate) {
|
||||
const s = await getState();
|
||||
await mutate(s);
|
||||
@@ -68,22 +70,27 @@ async function updateStateOnce(mutate) {
|
||||
|
||||
// Apply `mutate` to a record read fresh from storage and write the result
|
||||
// back. `mutate` receives a detached, normalized profile and mutates it in
|
||||
// place; it may be async, but it must not do anything slow. The write is the
|
||||
// WHOLE record, which is safe only because the lock (withLock() in
|
||||
// src/shared/browserApi.js) is held from the read to the write: two
|
||||
// background turns, or a turn and a page's save, never interleave
|
||||
// (https://git.eeqj.de/sneak/AutistMask/issues/641). Every page's save waits
|
||||
// while it is held, except a page in a Firefox private window, which Firefox
|
||||
// gives locks of its own (README, "Stored state and its version").
|
||||
// place; it may be async, but it must not do anything slow — the window
|
||||
// between the read and the write is the window in which another context's
|
||||
// write is lost, and keeping it to one storage round trip is what makes a
|
||||
// whole-record write safe here. Concretely: the write is the WHOLE record, so
|
||||
// a popup write that lands inside that window is reverted, in every field, by
|
||||
// the record this turn read before it. That is accepted because the window is
|
||||
// one round trip long and the popup is not writing while the worker is;
|
||||
// widening it is what would make it a real hazard.
|
||||
//
|
||||
// `mutate` must also not call updateState() itself, directly or through
|
||||
// anything it awaits: the inner turn waits for the lock the outer one holds,
|
||||
// and the outer one is waiting on the inner one. That deadlocks every write of
|
||||
// the stored record, not just the caller. Mutate the record you were handed.
|
||||
// anything it awaits: the queue is strictly serial, so the inner turn waits on
|
||||
// the outer one, which is waiting on the inner one. That deadlocks the whole
|
||||
// background, not just the caller. Mutate the record you were handed.
|
||||
//
|
||||
// Resolves with the record that was written.
|
||||
function updateState(mutate) {
|
||||
return withLock("autistmask", () => updateStateOnce(mutate));
|
||||
const turn = updateQueue.then(() => updateStateOnce(mutate));
|
||||
// The queue must advance even when a turn rejects, or every update after
|
||||
// it queues behind a promise that never settles.
|
||||
updateQueue = turn.catch(() => {});
|
||||
return turn;
|
||||
}
|
||||
|
||||
module.exports = { getState, updateState };
|
||||
|
||||
@@ -90,7 +90,7 @@
|
||||
<div id="add-wallet-section-mnemonic">
|
||||
<!-- The die button shares the instruction's row: on a row
|
||||
of its own it pushes Import below the fold at
|
||||
396x600. -->
|
||||
360x600. -->
|
||||
<div class="mb-2 flex justify-between items-start gap-2">
|
||||
<p>
|
||||
Enter your 12 or 24 word recovery phrase below, or
|
||||
@@ -212,7 +212,7 @@
|
||||
/>
|
||||
</div>
|
||||
<!-- The error line sits beside Import, not above it: at
|
||||
396x600 the button already starts near the bottom of
|
||||
360x600 the button already starts near the bottom of
|
||||
the popup, and a line of its own would push it below
|
||||
the fold. The longest error fits on one line here. -->
|
||||
<div class="flex items-center gap-2">
|
||||
|
||||
+5
-36
@@ -68,54 +68,23 @@ let refreshInFlight = false;
|
||||
// the recovery screen: there is no profile left to refresh.
|
||||
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,
|
||||
// changes only the stored record. 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() {
|
||||
if (refreshInFlight) return;
|
||||
refreshInFlight = true;
|
||||
try {
|
||||
const networkId = state.networkId;
|
||||
const wallets = structuredClone(state.wallets);
|
||||
await Promise.all([
|
||||
refreshPrices(),
|
||||
refreshBalances(
|
||||
wallets,
|
||||
state.wallets,
|
||||
state.rpcUrl,
|
||||
state.blockscoutUrl,
|
||||
state.trackedTokens,
|
||||
networkId,
|
||||
state.networkId,
|
||||
pageClosed.signal,
|
||||
),
|
||||
]);
|
||||
const refreshed = new Map();
|
||||
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;
|
||||
});
|
||||
state.lastBalanceRefresh = Date.now();
|
||||
await saveState();
|
||||
renderWalletList();
|
||||
} catch (e) {
|
||||
// Every call site fires this and walks away — the boot below, the ten
|
||||
@@ -251,7 +220,7 @@ async function widenApprovalWindow() {
|
||||
async function init() {
|
||||
// First, before anything can save: showView() saves on every navigation
|
||||
// without awaiting, so a save that fails from here on has somewhere to be
|
||||
// reported rather than reaching only the console
|
||||
// reported rather than being swallowed by the save queue
|
||||
// (https://git.eeqj.de/sneak/AutistMask/issues/362). Registered ahead of
|
||||
// the approval-window branch below too, since that window saves as well.
|
||||
//
|
||||
|
||||
@@ -231,11 +231,10 @@ function showTxFee(approvedTx) {
|
||||
const feePerGas = BigInt(approvedTx.maxFeePerGas || approvedTx.gasPrice);
|
||||
// Through formatFee(), as the confirmation screen's fee is, so the same
|
||||
// fee reads the same on both. In the native currency of the network shown
|
||||
// above, and at the price on it, as the value is.
|
||||
// above, as the value is.
|
||||
$("approve-tx-fee").textContent = formatFee(
|
||||
gasLimit * feePerGas,
|
||||
nativeCurrencyByChainId(approvedTx.chainId),
|
||||
approvedTx.chainId,
|
||||
);
|
||||
|
||||
let detail =
|
||||
@@ -368,12 +367,11 @@ function showTxApproval(details) {
|
||||
$("approve-tx-to").innerHTML = escapeHtml(CONTRACT_CREATION_TEXT);
|
||||
}
|
||||
|
||||
const ethValueFormatted = formatTxValue(ethValue);
|
||||
// Priced from the exact value, not the four-decimal figure, at the price
|
||||
// on the network the transaction is for, as the confirmation screen prices
|
||||
// its amount, so the same value reads the same on both.
|
||||
const ethPrice = getPrice("ETH", approvedTx.chainId);
|
||||
const ethUsd = ethPrice ? parseFloat(ethValue) * ethPrice : null;
|
||||
const ethValueFormatted = formatTxValue(
|
||||
formatEther(approvedTx.value || "0"),
|
||||
);
|
||||
const ethPrice = getPrice("ETH");
|
||||
const ethUsd = ethPrice ? parseFloat(ethValueFormatted) * ethPrice : null;
|
||||
const usdStr = formatUsd(ethUsd);
|
||||
// In the native currency of the network the transaction is for, which the
|
||||
// Network line names, not the active network's: the active network can
|
||||
|
||||
@@ -24,11 +24,7 @@
|
||||
// than written again locally so that tests/popupElementIds.test.js sees these
|
||||
// lookups and holds every id below against the markup.
|
||||
const { $, VIEWS } = require("./helpers");
|
||||
const {
|
||||
storageGet,
|
||||
storageRemove,
|
||||
withLock,
|
||||
} = require("../../shared/browserApi");
|
||||
const { storageGet, storageRemove } = require("../../shared/browserApi");
|
||||
const { log } = require("../../shared/log");
|
||||
|
||||
// Typed in full before anything is erased, in the same spirit as the wallet
|
||||
@@ -141,11 +137,7 @@ async function resetProfile() {
|
||||
return;
|
||||
}
|
||||
try {
|
||||
// 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"));
|
||||
await storageRemove("autistmask");
|
||||
} catch (e) {
|
||||
log.errorf("state recovery: reset failed:", e);
|
||||
setFlash("The saved data could not be erased. Nothing was changed.");
|
||||
|
||||
@@ -31,11 +31,6 @@
|
||||
// Everything is resolved on use rather than captured at module load. The MV3
|
||||
// service worker is torn down and re-evaluated repeatedly, and the unit
|
||||
// suite installs its stubs on `global.chrome` around a require().
|
||||
//
|
||||
// The 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.
|
||||
//
|
||||
@@ -224,33 +219,6 @@ function storageRemove(keys) {
|
||||
return Promise.resolve(storage.remove(keys));
|
||||
}
|
||||
|
||||
/**
|
||||
* 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
|
||||
// until the browser closes. It survives the background worker being stopped
|
||||
// and started again, which module-level variables do not (README, Background
|
||||
@@ -405,5 +373,4 @@ module.exports = {
|
||||
windowsGetLastFocused,
|
||||
windowsRemove,
|
||||
windowsUpdate,
|
||||
withLock,
|
||||
};
|
||||
|
||||
@@ -38,12 +38,11 @@ function clearPrices() {
|
||||
}
|
||||
|
||||
// Return the USD price for a symbol on the network with `chainId`, or on the
|
||||
// active network when no chain id is given; null on testnet, on a chain id
|
||||
// that names no network, or for a symbol with no price.
|
||||
// active network when no chain id is given; null on testnet / unknown.
|
||||
function getPrice(symbol, chainId) {
|
||||
const { currentNetwork } = require("./state");
|
||||
const network = chainId ? networkByChainId(chainId) : currentNetwork();
|
||||
if (!network || network.isTestnet) return null;
|
||||
if (network.isTestnet) return null;
|
||||
return prices[symbol] || null;
|
||||
}
|
||||
|
||||
|
||||
+34
-36
@@ -35,7 +35,7 @@ const {
|
||||
migrationNeeded,
|
||||
} = require("./stateSchema");
|
||||
|
||||
const { storageGet, storageSet, withLock } = require("./browserApi");
|
||||
const { storageGet, storageSet } = require("./browserApi");
|
||||
const { log } = require("./log");
|
||||
|
||||
// The live record the proxy below guards. Everything inside this module reads
|
||||
@@ -458,8 +458,8 @@ function mergeNetworkEndpoints(base, ours, theirs) {
|
||||
// This page's own live `state` is deliberately NOT rehydrated from a field
|
||||
// another page changed — only the record written to storage is merged.
|
||||
// showView() fires saveState() on every navigation without awaiting it,
|
||||
// which is why saves from one page wait for each other (see saveState()), and
|
||||
// a save that is slow to come back has no way to tell whether the field it
|
||||
// which is what makes the queue above necessary in the first place, and a
|
||||
// save that is slow to come back has no way to tell whether the field it
|
||||
// is about to hand back is still the current answer or has since been
|
||||
// overtaken by something this very page did in the meantime; writing it
|
||||
// into `state` regardless reintroduced exactly the clobber this function
|
||||
@@ -467,7 +467,11 @@ function mergeNetworkEndpoints(base, ours, theirs) {
|
||||
// (caught by tests/txStatus.test.js). A page's live picture of a field it
|
||||
// does not own goes on being whatever its last loadState() saw, same as
|
||||
// before this fix; only the persisted record is guaranteed current.
|
||||
async function saveStateOnce(beforeWrite) {
|
||||
async function saveStateOnce() {
|
||||
// A copy, so what this save compares and writes is the page's state as it
|
||||
// stood when the save began. A change made while it waits on storage is
|
||||
// left for the next save, which compares against this copy.
|
||||
const current = structuredClone(snapshotPersisted());
|
||||
const result = await storageGet("autistmask");
|
||||
// The record in storage right now is about to be merged into and written
|
||||
// back, so it is validated exactly like a load validates it. Without this,
|
||||
@@ -481,12 +485,6 @@ async function saveStateOnce(beforeWrite) {
|
||||
// come from storage in its loaded (self-healed) shape. See
|
||||
// normalizePersisted() in persistedState.js.
|
||||
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 };
|
||||
for (const key of PERSISTED_FIELDS) {
|
||||
@@ -531,21 +529,35 @@ async function saveStateOnce(beforeWrite) {
|
||||
rawState.hasWallet = rawState.wallets.length > 0;
|
||||
|
||||
// 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 next
|
||||
// save finds nothing to store
|
||||
// made during the save must still differ from the baseline, or the save
|
||||
// queued after it finds nothing to store
|
||||
// (https://git.eeqj.de/sneak/AutistMask/issues/448).
|
||||
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
|
||||
// to say it on (src/popup/index.js).
|
||||
//
|
||||
// A save that fails must not fail silently. showView() fires saveState() on
|
||||
// every navigation without awaiting it, and `await saveState()` inside an
|
||||
// unguarded event handler is no better: either way, without this, a failure
|
||||
// would reach only the console, where the user never looks, and the wallet
|
||||
// would keep running against storage that rejects every write. That is the
|
||||
// data-loss half of https://git.eeqj.de/sneak/AutistMask/issues/362.
|
||||
// every navigation without awaiting it, and the queue below has to attach a
|
||||
// rejection handler to keep advancing — so a failing save was swallowed
|
||||
// entirely: no throw, no message, nothing on screen. The wallet kept running
|
||||
// against storage that was rejecting every write, which is the data-loss half
|
||||
// of https://git.eeqj.de/sneak/AutistMask/issues/362. The awaited callers were
|
||||
// no better off: `await saveState()` inside an unguarded event handler surfaces
|
||||
// in the console and nowhere the user looks.
|
||||
//
|
||||
// This is the "tell the user" half; the other half is the floor in
|
||||
// normalizePersisted(), which stops the malformed-record cause from arising in
|
||||
@@ -571,25 +583,11 @@ function reportSaveFailure(err) {
|
||||
}
|
||||
}
|
||||
|
||||
// Each save runs start to finish holding the lock every write of the stored
|
||||
// record takes (withLock() in src/shared/browserApi.js), so no write by
|
||||
// another page or the background lands between its read and its write and is
|
||||
// lost (https://git.eeqj.de/sneak/AutistMask/issues/641). A page in a Firefox
|
||||
// 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));
|
||||
function saveState() {
|
||||
const turn = saveQueue.then(saveStateOnce);
|
||||
// The queue must advance even when a save rejects, or every save after
|
||||
// it queues behind a promise that never settles.
|
||||
saveQueue = turn.catch(() => {});
|
||||
// Every failed save is reported, whether or not the caller awaited this
|
||||
// one. The returned promise still rejects, so a caller that DOES await
|
||||
// keeps its own error handling.
|
||||
|
||||
@@ -20,7 +20,6 @@ const { toDecimals } = require("./transferAmount");
|
||||
// truncation without the approval screens' nonzero floor: the transaction
|
||||
// detail view is the authoritative record and already shows exact precision.
|
||||
const { truncateAmount: formatTxValue } = require("./amountDisplay");
|
||||
const { routerRelease } = require("./uniswap");
|
||||
|
||||
// Ethereum addresses are case-insensitive: EIP-55 mixed case is a checksum
|
||||
// over the address, not part of its identity. Every address comparison in
|
||||
@@ -52,6 +51,7 @@ function parseTx(tx, addrLower, chainId) {
|
||||
}
|
||||
// Map known DEX methods to "Swap" for cleaner display
|
||||
const SWAP_METHODS = new Set([
|
||||
"execute",
|
||||
"swap",
|
||||
"swapExactTokensForTokens",
|
||||
"swapTokensForExactTokens",
|
||||
@@ -59,16 +59,9 @@ function parseTx(tx, addrLower, chainId) {
|
||||
"swapTokensForExactETH",
|
||||
"swapExactTokensForETH",
|
||||
"swapETHForExactTokens",
|
||||
"multicall",
|
||||
]);
|
||||
// Multisigs, smart accounts and many other contracts also have an
|
||||
// `execute` or `multicall` method, so either is a swap only when sent
|
||||
// to a Universal Router on this transaction's network: the same
|
||||
// addresses the approval screen decodes a swap for.
|
||||
const isSwap =
|
||||
SWAP_METHODS.has(method) ||
|
||||
((method === "execute" || method === "multicall") &&
|
||||
routerRelease(to, chainId) !== null);
|
||||
const label = isSwap
|
||||
const label = SWAP_METHODS.has(method)
|
||||
? "Swap"
|
||||
: method.charAt(0).toUpperCase() + method.slice(1);
|
||||
direction = "contract";
|
||||
|
||||
+118
-615
File diff suppressed because it is too large
Load Diff
@@ -115,7 +115,7 @@ function decodedLine(label) {
|
||||
// `tokenBalances` there, for the site's transaction sending TRANSFER_DATA to
|
||||
// the token, on Sepolia unless `chainId` names another chain. Confirm answers
|
||||
// the signed transaction with a failure, which leads to the error screen.
|
||||
async function showTokenTransfer(
|
||||
async function showSepoliaTransfer(
|
||||
tokenBalances = [],
|
||||
chainId = NETWORKS.sepolia.chainId,
|
||||
) {
|
||||
@@ -191,7 +191,7 @@ describe("a token tracked on Sepolia only", () => {
|
||||
});
|
||||
|
||||
test("is named on the Contract line and the decoded Token line, with its amount at its scale", async () => {
|
||||
await showTokenTransfer();
|
||||
await showSepoliaTransfer();
|
||||
expect(node("approve-tx-to").innerHTML).toContain(
|
||||
'<div class="font-bold mb-1">TDOL</div>',
|
||||
);
|
||||
@@ -204,7 +204,7 @@ describe("a token tracked on Sepolia only", () => {
|
||||
});
|
||||
|
||||
test("labels the amount on the error screen that follows", async () => {
|
||||
await showTokenTransfer();
|
||||
await showSepoliaTransfer();
|
||||
await confirm();
|
||||
expect(state.currentView).toBe("error-tx");
|
||||
expect(node("error-tx-summary").textContent).toBe("1234.5000 TDOL");
|
||||
@@ -215,7 +215,7 @@ describe("a token tracked on Sepolia only", () => {
|
||||
// tracks and holds there names nothing on Sepolia.
|
||||
test("a token tracked and held on mainnet only is not named, and its amount is in base units", async () => {
|
||||
state.trackedTokens = [{ address: TOKEN, symbol: "MDOL", decimals: 18 }];
|
||||
await showTokenTransfer([
|
||||
await showSepoliaTransfer([
|
||||
{ address: TOKEN, symbol: "MDOL", decimals: 18, balance: "1.0" },
|
||||
]);
|
||||
expect(node("approve-tx-to").innerHTML).not.toContain("MDOL");
|
||||
@@ -229,7 +229,7 @@ test("a token tracked and held on mainnet only is not named, and its amount is i
|
||||
|
||||
// The From and Contract lines, and the decoded Token and Recipient lines.
|
||||
test("every address links to the Sepolia explorer", async () => {
|
||||
await showTokenTransfer();
|
||||
await showSepoliaTransfer();
|
||||
const sepolia = NETWORKS.sepolia.explorerUrl;
|
||||
expect(node("approve-tx-from").innerHTML).toContain(
|
||||
`href="${sepolia}/address/${FROM}"`,
|
||||
@@ -254,7 +254,7 @@ test("every address links to the Sepolia explorer", async () => {
|
||||
|
||||
// Chain id 1337 names no network here, so it has no explorer to link to.
|
||||
test("a transaction on a chain id that names no network is shown with no address links", async () => {
|
||||
await showTokenTransfer([], "0x539");
|
||||
await showSepoliaTransfer([], "0x539");
|
||||
expect(state.currentView).toBe("approve-tx");
|
||||
expect(node("approve-tx-network").textContent).toBe(
|
||||
"Unknown network (chain id 1337)",
|
||||
|
||||
@@ -1,192 +0,0 @@
|
||||
// The USD value on the approval screen's Value and Network fee lines, for a
|
||||
// site's ETH send.
|
||||
//
|
||||
// It was worked out from the four-decimal figure the line shows, at the price
|
||||
// on the active network, so the same value read a few cents different here than
|
||||
// on the confirmation screen, which prices the exact amount at the price on the
|
||||
// transaction's own network, and a transaction on another network than the
|
||||
// active one was priced at the active one's rate, its fee too
|
||||
// (https://git.eeqj.de/sneak/AutistMask/issues/614).
|
||||
//
|
||||
// Driven through the real approval screen, against a minimal DOM stub in the
|
||||
// shape tests/approvalTokenNetwork.test.js uses.
|
||||
|
||||
globalThis.chrome = {
|
||||
storage: { local: { get: async () => ({}), set: async () => {} } },
|
||||
};
|
||||
|
||||
const { state } = require("../src/shared/state");
|
||||
const { NETWORKS } = require("../src/shared/networks");
|
||||
const { prices, clearPrices } = require("../src/shared/prices");
|
||||
const approval = require("../src/popup/views/approval");
|
||||
|
||||
const FROM = "0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266";
|
||||
const RECIPIENT = "0x711e691962E5c054b78071C789A0C8CE657377aD";
|
||||
|
||||
function makeElement(id) {
|
||||
const classes = new Set();
|
||||
const el = {
|
||||
id,
|
||||
textContent: "",
|
||||
value: "",
|
||||
innerHTML: "",
|
||||
disabled: false,
|
||||
style: {},
|
||||
dataset: {},
|
||||
listeners: {},
|
||||
classList: {
|
||||
add: (...names) => names.forEach((n) => classes.add(n)),
|
||||
remove: (...names) => names.forEach((n) => classes.delete(n)),
|
||||
contains: (n) => classes.has(n),
|
||||
toggle: (n, force) => {
|
||||
const on = force === undefined ? !classes.has(n) : force;
|
||||
if (on) classes.add(n);
|
||||
else classes.delete(n);
|
||||
return on;
|
||||
},
|
||||
},
|
||||
addEventListener: (name, fn) => {
|
||||
el.listeners[name] = el.listeners[name] || [];
|
||||
el.listeners[name].push(fn);
|
||||
},
|
||||
querySelectorAll: () => [],
|
||||
appendChild: () => {},
|
||||
};
|
||||
// Views reach for .parentElement to hide whole sections.
|
||||
Object.defineProperty(el, "parentElement", {
|
||||
get: () => node(id + "-parent"),
|
||||
});
|
||||
return el;
|
||||
}
|
||||
|
||||
function makeDocument() {
|
||||
const els = new Map();
|
||||
return {
|
||||
getElementById(id) {
|
||||
// The debug banner is created on demand by helpers.js; absent
|
||||
// is the state a non-debug, non-testnet popup is in.
|
||||
if (id === "debug-banner") return null;
|
||||
if (!els.has(id)) els.set(id, makeElement(id));
|
||||
return els.get(id);
|
||||
},
|
||||
createElement: () => makeElement("created"),
|
||||
body: { prepend: () => {} },
|
||||
};
|
||||
}
|
||||
|
||||
function node(id) {
|
||||
return globalThis.document.getElementById(id);
|
||||
}
|
||||
|
||||
// Open the approval screen, with the network `networkId` active, for the
|
||||
// site's transaction sending 1.23414 ETH to RECIPIENT on the chain `chainId`.
|
||||
async function showEthSend(chainId, networkId) {
|
||||
globalThis.document = makeDocument();
|
||||
globalThis.window = { location: { search: "" }, close: () => {} };
|
||||
globalThis.chrome.runtime = {
|
||||
connect: () => ({ postMessage: () => {} }),
|
||||
sendMessage: (msg, reply) => {
|
||||
if (!reply) return;
|
||||
reply({
|
||||
type: "tx",
|
||||
origin: "https://dapp.example",
|
||||
isPhishingDomain: false,
|
||||
approvedFrom: FROM,
|
||||
approvedTx: {
|
||||
type: 2,
|
||||
from: FROM,
|
||||
chainId,
|
||||
nonce: "0x7",
|
||||
gasLimit: "0x5208",
|
||||
maxPriorityFeePerGas: "0x3b9aca00",
|
||||
maxFeePerGas: "0x77359400",
|
||||
to: RECIPIENT,
|
||||
value: "1234140000000000000",
|
||||
data: "0x",
|
||||
accessList: [],
|
||||
},
|
||||
});
|
||||
},
|
||||
};
|
||||
state.networkId = networkId;
|
||||
state.activeAddress = FROM;
|
||||
state.wallets = [
|
||||
{
|
||||
type: "hd",
|
||||
name: "Wallet 1",
|
||||
xpub: "xpub-wallet-1",
|
||||
encryptedSecret: "encrypted-secret-1",
|
||||
nextIndex: 1,
|
||||
addresses: [{ address: FROM, index: 0, balance: "0" }],
|
||||
},
|
||||
];
|
||||
state.trackedTokens = [];
|
||||
state.networkTrackedTokens = {};
|
||||
state.currentView = null;
|
||||
approval.init({});
|
||||
await approval.show(1);
|
||||
}
|
||||
|
||||
beforeEach(() => {
|
||||
prices.ETH = 2000;
|
||||
});
|
||||
|
||||
afterEach(() => {
|
||||
clearPrices();
|
||||
});
|
||||
|
||||
// 1.23414 ETH reads 1.2341 ETH. At $2,000 the exact value is $2,468.28, the
|
||||
// figure the confirmation screen shows for it; the shown figure would be
|
||||
// $2,468.20.
|
||||
test.each([
|
||||
[
|
||||
"a mainnet transaction is priced from its exact value",
|
||||
NETWORKS.mainnet.chainId,
|
||||
"mainnet",
|
||||
"1.2341 ETH ($2,468.28)",
|
||||
],
|
||||
[
|
||||
"a mainnet transaction shown with Sepolia active is priced at the mainnet price",
|
||||
NETWORKS.mainnet.chainId,
|
||||
"sepolia",
|
||||
"1.2341 ETH ($2,468.28)",
|
||||
],
|
||||
[
|
||||
"a Sepolia transaction shown with mainnet active has no USD value",
|
||||
NETWORKS.sepolia.chainId,
|
||||
"mainnet",
|
||||
"1.2341 SepoliaETH",
|
||||
],
|
||||
// Chain id 1337 names no network here, so nothing knows its price.
|
||||
[
|
||||
"a transaction on a chain id that names no network has no USD value",
|
||||
"0x539",
|
||||
"mainnet",
|
||||
"1.2341 ETH",
|
||||
],
|
||||
])("%s", async (_label, chainId, networkId, expected) => {
|
||||
await showEthSend(chainId, networkId);
|
||||
expect(state.currentView).toBe("approve-tx");
|
||||
expect(node("approve-tx-value").textContent).toBe(expected);
|
||||
});
|
||||
|
||||
// The Network fee line is priced on the transaction's network too. 21000 gas at
|
||||
// up to 2 gwei is 0.000042 ETH, $0.08 at $2,000.
|
||||
test.each([
|
||||
[
|
||||
"the fee of a mainnet transaction shown with Sepolia active is priced at the mainnet price",
|
||||
NETWORKS.mainnet.chainId,
|
||||
"sepolia",
|
||||
"0.00004 ETH ($0.08)",
|
||||
],
|
||||
[
|
||||
"the fee of a Sepolia transaction shown with mainnet active has no USD value",
|
||||
NETWORKS.sepolia.chainId,
|
||||
"mainnet",
|
||||
"0.00004 SepoliaETH",
|
||||
],
|
||||
])("%s", async (_label, chainId, networkId, expected) => {
|
||||
await showEthSend(chainId, networkId);
|
||||
expect(state.currentView).toBe("approve-tx");
|
||||
expect(node("approve-tx-fee").textContent).toBe(expected);
|
||||
});
|
||||
@@ -19,10 +19,7 @@
|
||||
// that followed persisted the pre-refresh values — while still stamping
|
||||
// lastBalanceRefresh, suppressing the redo.
|
||||
//
|
||||
// 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
|
||||
// Both use the real persistence path over a cloning storage stub. Nothing here
|
||||
// asserts the absence of a loadState() call; each asserts the OUTCOME, so it
|
||||
// holds against any implementation that gets the outcome right.
|
||||
|
||||
@@ -398,48 +395,3 @@ describe("a balance refresh under another handler's state read", () => {
|
||||
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,
|
||||
);
|
||||
});
|
||||
});
|
||||
|
||||
@@ -1,160 +0,0 @@
|
||||
// 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 stored record still holds Ethereum Mainnet while the refresh's save reads
|
||||
// it, so only this page's own network shows the switch.
|
||||
test("a refresh whose save is reading the stored record when the user switches in Settings writes nothing", 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.
|
||||
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);
|
||||
});
|
||||
@@ -158,7 +158,7 @@ global.document = {
|
||||
body: { prepend() {}, appendChild() {} },
|
||||
addEventListener() {},
|
||||
};
|
||||
global.navigator.clipboard = { writeText() {} };
|
||||
global.navigator = { clipboard: { writeText() {} } };
|
||||
|
||||
const {
|
||||
Interface,
|
||||
|
||||
@@ -189,7 +189,7 @@ global.document = {
|
||||
body: { prepend() {}, appendChild() {} },
|
||||
addEventListener() {},
|
||||
};
|
||||
global.navigator.clipboard = { writeText() {} };
|
||||
global.navigator = { clipboard: { writeText() {} } };
|
||||
|
||||
const {
|
||||
BaseWallet,
|
||||
|
||||
@@ -101,7 +101,7 @@ describe("the flash line the message is shown in", () => {
|
||||
//
|
||||
// The line cuts a message too long for it with an ellipsis (see
|
||||
// showFlash() in src/popup/views/helpers.js). The assertions that
|
||||
// measure that, in a real browser at the documented 396x600 popup, are
|
||||
// measure that, in a real browser at the documented 360x600 popup, are
|
||||
// "a rejected dust threshold shifts no layout (#233)" and "an over-long
|
||||
// flash message keeps to one line (#252)" in tests/e2e/run.js, run by
|
||||
// make test-e2e. They are not in make check because REPO_POLICIES.md
|
||||
|
||||
+11
-32
@@ -60,14 +60,6 @@ const TEST_TIMEOUT_MS = 120000;
|
||||
// trailing drain in main().
|
||||
const TRAILING_WATCH_MS = 1500;
|
||||
|
||||
// The popup's size, as README gives it: `body` in src/popup/styles/main.css
|
||||
// is 396px wide, and src/background/index.js opens an approval window at
|
||||
// the same 396x600. Pages in this context otherwise get Playwright's
|
||||
// 1280x720 default, where the page never scrolls sideways and a button
|
||||
// below the popup's fold is still on screen, so a layout measured there
|
||||
// passes whatever the page does.
|
||||
const POPUP_VIEWPORT = { width: 396, height: 600 };
|
||||
|
||||
const tests = [];
|
||||
|
||||
function test(name, fn) {
|
||||
@@ -367,14 +359,11 @@ async function leaveTransactionDetail(page) {
|
||||
await openAddressDetail(page);
|
||||
}
|
||||
|
||||
// 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.
|
||||
// Back out to Home from wherever the previous test finished.
|
||||
async function goHome(page) {
|
||||
await leaveTransactionDetail(page);
|
||||
await page.click("#btn-address-back");
|
||||
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
|
||||
@@ -1896,6 +1885,12 @@ test("a network switch in Settings shows and removes the testnet banner at once
|
||||
|
||||
// ------------------------------------------------ dust threshold (#233)
|
||||
|
||||
// The popup size README documents the UI as designed for. Pages in this
|
||||
// context otherwise get Playwright's 1280x720 default, at which the flash
|
||||
// line has room for any plausible message and never wraps — measuring
|
||||
// there would pass for every string and prove nothing.
|
||||
const POPUP_VIEWPORT = { width: 360, height: 600 };
|
||||
|
||||
// Everything below the flash line that must not move when it fills, plus
|
||||
// the height of the line itself. Runs in the page.
|
||||
//
|
||||
@@ -2144,7 +2139,7 @@ test("a password error moves nothing on any screen (#297)", async (env) => {
|
||||
|
||||
// ------------------------------------------ add wallet Import button (#493)
|
||||
|
||||
// At 396x600 the add wallet screen's Import button already starts near the
|
||||
// At 360x600 the add wallet screen's Import button already starts near the
|
||||
// bottom of the popup, so its password error line sits beside the button
|
||||
// rather than above it. Measures the button and the line empty and again
|
||||
// filled with the longest error addWallet.js puts there. Runs in the page.
|
||||
@@ -3436,14 +3431,10 @@ test("six failed receipt lookups in a row end on the unreachable-network message
|
||||
// timeout ("<iframe id=\"pwn\"> intercepts pointer events") rather than as
|
||||
// anything that names the defect.
|
||||
|
||||
// The issue's reproduction, with the frame sized to the popup.
|
||||
// Verbatim from the issue's reproduction.
|
||||
const HOSTILE_SYMBOL =
|
||||
'<iframe id="pwn" src="https://dapp.e2e.test/" ' +
|
||||
'style="position:fixed;left:0;top:0;width:' +
|
||||
POPUP_VIEWPORT.width +
|
||||
"px;height:" +
|
||||
POPUP_VIEWPORT.height +
|
||||
'px;z-index:99999"></iframe>';
|
||||
'style="position:fixed;left:0;top:0;width:360px;height:600px;z-index:99999"></iframe>';
|
||||
|
||||
// What a correctly escaped and capped render of it reads as: the first
|
||||
// MAX_SYMBOL_LENGTH-1 characters and an ellipsis. Spelled out rather than
|
||||
@@ -5035,20 +5026,8 @@ function addressRowReport(page) {
|
||||
});
|
||||
}
|
||||
|
||||
// Measured at the popup's 396x600 (POPUP_VIEWPORT). Every page in this
|
||||
// context, approval windows included, is otherwise 1280x720 whatever size
|
||||
// the extension asks for, and a page that wide never scrolls sideways. The
|
||||
// page is then put back to the size it had, so the size a later step runs at
|
||||
// does not depend on whether this one ran.
|
||||
async function assertAddressesFit(page, where) {
|
||||
const sizeBefore = page.viewportSize();
|
||||
await page.setViewportSize(POPUP_VIEWPORT);
|
||||
let report;
|
||||
try {
|
||||
report = await addressRowReport(page);
|
||||
} finally {
|
||||
await page.setViewportSize(sizeBefore);
|
||||
}
|
||||
const report = await addressRowReport(page);
|
||||
assert(
|
||||
report.rows.length > 0,
|
||||
where + ": no address rows were rendered, so nothing was measured",
|
||||
|
||||
@@ -151,7 +151,7 @@ global.document = {
|
||||
body: { prepend() {}, appendChild() {} },
|
||||
addEventListener() {},
|
||||
};
|
||||
global.navigator.clipboard = { writeText() {} };
|
||||
global.navigator = { clipboard: { writeText() {} } };
|
||||
|
||||
const { state } = require("../src/shared/state");
|
||||
const { NETWORKS } = require("../src/shared/networks");
|
||||
|
||||
@@ -364,7 +364,7 @@ describe("a save that fails", () => {
|
||||
return storage;
|
||||
}
|
||||
|
||||
test("is reported when the caller does not await it", async () => {
|
||||
test("is reported, not swallowed by the save queue", async () => {
|
||||
const storage = failingStorage(unversionedValidProfile());
|
||||
const { state, loadState, saveState, onSaveFailure } =
|
||||
loadStateModule(storage);
|
||||
|
||||
@@ -97,7 +97,7 @@ global.document = {
|
||||
body: { prepend() {}, appendChild() {} },
|
||||
addEventListener() {},
|
||||
};
|
||||
global.navigator.clipboard = { writeText() {} };
|
||||
global.navigator = { clipboard: { writeText() {} } };
|
||||
|
||||
const { state } = require("../src/shared/state");
|
||||
const send = require("../src/popup/views/send");
|
||||
|
||||
@@ -151,7 +151,7 @@ global.document = {
|
||||
body: { prepend() {}, appendChild() {} },
|
||||
addEventListener() {},
|
||||
};
|
||||
global.navigator.clipboard = { writeText() {} };
|
||||
global.navigator = { clipboard: { writeText() {} } };
|
||||
|
||||
const { refreshBalances } = require("../src/shared/balances");
|
||||
const { state } = require("../src/shared/state");
|
||||
|
||||
@@ -146,7 +146,7 @@ global.document = {
|
||||
body: { prepend() {}, appendChild() {} },
|
||||
addEventListener() {},
|
||||
};
|
||||
global.navigator.clipboard = { writeText() {} };
|
||||
global.navigator = { clipboard: { writeText() {} } };
|
||||
|
||||
const { Transaction, Wallet, formatEther } = require("ethers");
|
||||
const { refreshBalances } = require("../src/shared/balances");
|
||||
|
||||
@@ -160,7 +160,7 @@ describe("the approval-window reproduction", () => {
|
||||
await approvalWindow.state.loadState();
|
||||
approvalWindow.helpers.showView("approve-tx");
|
||||
// showView() does not await its own saveState(); an extra save
|
||||
// waits for the lock behind that one and so resolves only after it,
|
||||
// joins the same queue and only resolves once that one has too,
|
||||
// which is the black-box way to know it landed.
|
||||
await approvalWindow.state.saveState();
|
||||
|
||||
|
||||
@@ -1,96 +0,0 @@
|
||||
// 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");
|
||||
});
|
||||
@@ -1,27 +0,0 @@
|
||||
// `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 } };
|
||||
+15
-1539
File diff suppressed because it is too large
Load Diff
+25
-602
@@ -7,12 +7,9 @@
|
||||
// (https://git.eeqj.de/sneak/AutistMask/issues/592), the address whose
|
||||
// balance a BALANCE_CHECK_ERC20 checks
|
||||
// (https://git.eeqj.de/sneak/AutistMask/issues/600), any token a swap
|
||||
// leaves in the router (https://git.eeqj.de/sneak/AutistMask/issues/606),
|
||||
// leaves in the router (https://git.eeqj.de/sneak/AutistMask/issues/606), and
|
||||
// what each PERMIT2_TRANSFER_FROM moves
|
||||
// (https://git.eeqj.de/sneak/AutistMask/issues/611), and when an
|
||||
// UNWRAP_WETH makes the output ETH
|
||||
// (https://git.eeqj.de/sneak/AutistMask/issues/607 and
|
||||
// https://git.eeqj.de/sneak/AutistMask/issues/642).
|
||||
// (https://git.eeqj.de/sneak/AutistMask/issues/611).
|
||||
//
|
||||
// Every swap command, SWEEP, WRAP_ETH, UNWRAP_WETH, TRANSFER, PAY_PORTION,
|
||||
// PAY_PORTION_FULL_PRECISION, PERMIT2_TRANSFER_FROM, ACROSS_V4_DEPOSIT_V3 and
|
||||
@@ -271,28 +268,18 @@ const SWAP_USDT_FOR_ETH = [
|
||||
[[[ZERO, USDT, 500, 10, ZERO], false, USDT_2000, ONE_WETH, "0x"]],
|
||||
),
|
||||
];
|
||||
const SWAP_USDT_FOR_WETH = [
|
||||
0x06, // SWAP_EXACT_IN_SINGLE
|
||||
coder.encode(
|
||||
[
|
||||
"tuple(tuple(address,address,uint24,int24,address),bool,uint128,uint128,bytes)",
|
||||
],
|
||||
[[[USDT, WETH, 500, 10, ZERO], true, USDT_2000, ONE_WETH, "0x"]],
|
||||
),
|
||||
];
|
||||
// SWAP_EXACT_IN_SINGLE with no parameters, which cannot be read.
|
||||
const UNREADABLE_SWAP = [0x06, "0x"];
|
||||
const SETTLE_USDT = [
|
||||
0x0b,
|
||||
coder.encode(["address", "uint256", "bool"], [USDT, 0n, true]),
|
||||
];
|
||||
// A TAKE of `amount`, by default zero: the open delta, all the step owes.
|
||||
function take(currency, recipient, amount = 0n) {
|
||||
function take(currency, recipient) {
|
||||
return [
|
||||
0x0e,
|
||||
coder.encode(
|
||||
["address", "address", "uint256"],
|
||||
[currency, recipient, amount],
|
||||
[currency, recipient, 0n],
|
||||
),
|
||||
];
|
||||
}
|
||||
@@ -400,18 +387,6 @@ describe("each swap command's recipient", () => {
|
||||
data: (r) => execute(swapToWeth(r)),
|
||||
min: "1.0000 WETH",
|
||||
},
|
||||
{
|
||||
// Its input has V3_SWAP_EXACT_IN's layout, with amountOut and
|
||||
// amountInMax in place of amountIn and amountOutMin, and a path
|
||||
// that lists the token bought first.
|
||||
kind: "V3_SWAP_EXACT_OUT",
|
||||
data: (r) =>
|
||||
execute([
|
||||
0x01,
|
||||
v3SwapExactIn(r, ONE_WETH, USDT_2000, WETH, USDT)[1],
|
||||
]),
|
||||
min: "1.0000 WETH",
|
||||
},
|
||||
{
|
||||
kind: "V4_SWAP with TAKE",
|
||||
data: (r) =>
|
||||
@@ -544,7 +519,7 @@ describe("an output left in the router is not received", () => {
|
||||
{
|
||||
kind: "an UNWRAP_WETH to the user, then the swap",
|
||||
data: execute(unwrapWeth(MSG_SENDER), toRouter),
|
||||
min: "1.0000 WETH",
|
||||
min: "1.0000 ETH",
|
||||
},
|
||||
{
|
||||
kind: "the swap, then a WRAP_ETH of zero to the user",
|
||||
@@ -581,530 +556,6 @@ describe("an output left in the router is not received", () => {
|
||||
});
|
||||
});
|
||||
|
||||
// https://git.eeqj.de/sneak/AutistMask/issues/607: an UNWRAP_WETH pays out,
|
||||
// as ETH, the WETH the router holds when it runs. Token Out read ETH whenever
|
||||
// the output side was WETH, so a swap that paid its WETH to the user before
|
||||
// the UNWRAP_WETH read as ETH, though the user receives WETH.
|
||||
describe("an UNWRAP_WETH makes the output ETH only when the router holds it", () => {
|
||||
test("a swap paying its WETH to the user, then an UNWRAP_WETH, reads as WETH", () => {
|
||||
const result = decode(
|
||||
execute(swapToWeth(MSG_SENDER), unwrapWeth(MSG_SENDER)),
|
||||
);
|
||||
expect(result.name).toBe("Swap USDT → WETH");
|
||||
expect(labels(result)).toEqual(PAID_TO_USER);
|
||||
expect(detail(result, "Min. received").value).toBe("1.0000 WETH");
|
||||
});
|
||||
|
||||
test("a swap paying its WETH to the router, then an UNWRAP_WETH to the user, reads as ETH", () => {
|
||||
const result = decode(
|
||||
execute(swapToWeth(ADDRESS_THIS), unwrapWeth(MSG_SENDER)),
|
||||
);
|
||||
expect(result.name).toBe("Swap USDT → ETH");
|
||||
expect(labels(result)).toEqual(PAID_TO_USER);
|
||||
expect(detail(result, "Min. received").value).toBe("1.0000 ETH");
|
||||
});
|
||||
|
||||
// The SWEEP pays the user all the WETH the router holds, so the
|
||||
// UNWRAP_WETH finds none of it.
|
||||
test("a swap paying its WETH to the router, then a SWEEP of it to the user, then an UNWRAP_WETH, reads as WETH", () => {
|
||||
const result = decode(
|
||||
execute(
|
||||
swapToWeth(ADDRESS_THIS),
|
||||
sweep(WETH, MSG_SENDER),
|
||||
unwrapWeth(MSG_SENDER),
|
||||
),
|
||||
);
|
||||
expect(result.name).toBe("Swap USDT → WETH");
|
||||
expect(detail(result, "Min. received").value).toBe("1.0000 WETH");
|
||||
});
|
||||
|
||||
// The user receives the first step's WETH as WETH and the second's as
|
||||
// ETH. The second step sets the output side and pays its WETH to the
|
||||
// router, so the output reads as ETH with the second step's minimum.
|
||||
test("two swaps, the second paying its WETH to the router, then an UNWRAP_WETH, reads as ETH", () => {
|
||||
const result = decode(
|
||||
execute(
|
||||
swapToWeth(MSG_SENDER),
|
||||
v2Swap(0x08, ADDRESS_THIS, USDC_1990, ONE_WETH / 2n, [
|
||||
USDC,
|
||||
WETH,
|
||||
]),
|
||||
unwrapWeth(MSG_SENDER),
|
||||
),
|
||||
);
|
||||
expect(result.name).toBe("Swap USDT → ETH");
|
||||
expect(detail(result, "Min. received").value).toBe("0.5000 ETH");
|
||||
});
|
||||
|
||||
// The same two swaps the other way round. The user receives the first
|
||||
// step's WETH as ETH and the second's as WETH. The second step sets the
|
||||
// output side and pays its WETH to the user, so the output reads as WETH
|
||||
// with the second step's minimum, though the router holds the first's.
|
||||
test("two swaps, the second paying its WETH to the user, then an UNWRAP_WETH, reads as WETH", () => {
|
||||
const result = decode(
|
||||
execute(
|
||||
v2Swap(0x08, ADDRESS_THIS, USDC_1990, ONE_WETH / 2n, [
|
||||
USDC,
|
||||
WETH,
|
||||
]),
|
||||
swapToWeth(MSG_SENDER),
|
||||
unwrapWeth(MSG_SENDER),
|
||||
),
|
||||
);
|
||||
expect(result.name).toBe("Swap USDC → WETH");
|
||||
expect(detail(result, "Min. received").value).toBe("1.0000 WETH");
|
||||
});
|
||||
|
||||
// One V4 step buys at least 1 WETH and TAKEs 0.6 WETH to the user and the
|
||||
// rest to the router. The user receives 0.6 WETH and the rest as ETH.
|
||||
// Neither minimum is shown: the decoder does not count how much of the
|
||||
// step's minimum reaches the router, nor read the UNWRAP_WETH's own.
|
||||
test("one V4 step paying part of its WETH to the user and the rest to the router, then an UNWRAP_WETH, reads as ETH with no minimum", () => {
|
||||
const result = decode(
|
||||
execute(
|
||||
v4Swap(
|
||||
SWAP_USDT_FOR_WETH,
|
||||
SETTLE_USDT,
|
||||
take(WETH, MSG_SENDER, (ONE_WETH * 6n) / 10n),
|
||||
take(WETH, ADDRESS_THIS),
|
||||
),
|
||||
unwrapWeth(MSG_SENDER),
|
||||
),
|
||||
);
|
||||
expect(result.name).toBe("Swap USDT → ETH");
|
||||
expect(labels(result)).toEqual([
|
||||
"Protocol",
|
||||
"Token In",
|
||||
"Amount",
|
||||
"Token Out",
|
||||
"Steps",
|
||||
"Deadline",
|
||||
]);
|
||||
});
|
||||
|
||||
// A TAKE the decoder cannot read may pay part of the WETH to the user.
|
||||
test("one V4 step paying WETH to the router beside a TAKE that cannot be read, then an UNWRAP_WETH, reads as ETH with no minimum", () => {
|
||||
const result = decode(
|
||||
execute(
|
||||
v4Swap(
|
||||
SWAP_USDT_FOR_WETH,
|
||||
SETTLE_USDT,
|
||||
withDirtyWord(take(WETH, MSG_SENDER), 1),
|
||||
take(WETH, ADDRESS_THIS),
|
||||
),
|
||||
unwrapWeth(MSG_SENDER),
|
||||
),
|
||||
);
|
||||
expect(result.name).toBe("Swap USDT → ETH");
|
||||
expect(detail(result, "Min. received")).toBeUndefined();
|
||||
expect(detail(result, "Min. paid out")).toBeUndefined();
|
||||
});
|
||||
|
||||
// A step after the UNWRAP_WETH that sets the output side sets it anew.
|
||||
test("a swap paying WETH to the user after an UNWRAP_WETH of an earlier swap's WETH reads as WETH", () => {
|
||||
const result = decode(
|
||||
execute(
|
||||
swapToWeth(ADDRESS_THIS),
|
||||
unwrapWeth(MSG_SENDER),
|
||||
v2Swap(0x08, MSG_SENDER, USDC_1990, ONE_WETH / 2n, [
|
||||
USDC,
|
||||
WETH,
|
||||
]),
|
||||
),
|
||||
);
|
||||
expect(result.name).toBe("Swap USDT → WETH");
|
||||
expect(detail(result, "Min. received").value).toBe("0.5000 WETH");
|
||||
});
|
||||
|
||||
// The EXECUTE_SUB_PLAN's own steps, which the decoder does not read, buy
|
||||
// the user USDC as well, so Token Out is not named.
|
||||
test("a swap paying its WETH to the router, then an UNWRAP_WETH, then an EXECUTE_SUB_PLAN, names no Token Out", () => {
|
||||
const subPlan = [
|
||||
0x21,
|
||||
coder.encode(
|
||||
["bytes", "bytes[]"],
|
||||
[
|
||||
"0x00",
|
||||
[
|
||||
v3SwapExactIn(
|
||||
MSG_SENDER,
|
||||
USDT_2000,
|
||||
USDC_1990,
|
||||
USDT,
|
||||
USDC,
|
||||
)[1],
|
||||
],
|
||||
],
|
||||
),
|
||||
];
|
||||
const result = decode(
|
||||
execute(swapToWeth(ADDRESS_THIS), unwrapWeth(MSG_SENDER), subPlan),
|
||||
);
|
||||
expect(result.name).toBe("Uniswap Swap");
|
||||
expect(detail(result, "Token Out").value).toBe(UNDECODED);
|
||||
expect(detail(result, "Min. received")).toBeUndefined();
|
||||
});
|
||||
});
|
||||
|
||||
// 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
|
||||
// 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
|
||||
@@ -1220,7 +671,6 @@ describe("any token left in the router is not received", () => {
|
||||
v3SwapExactIn(MSG_SENDER, USDT_2000, USDC_1990, USDT, USDC),
|
||||
),
|
||||
left: tokenLine(WETH, "WETH"),
|
||||
spent: "2000.0000 USDT",
|
||||
},
|
||||
{
|
||||
kind: "a WRAP_ETH of 1 ETH into the router, then a swap of 0.5 WETH from the router",
|
||||
@@ -1247,7 +697,6 @@ describe("any token left in the router is not received", () => {
|
||||
v2Swap(0x08, MSG_SENDER, ONE_WETH, USDC_1990, [WETH, USDC]),
|
||||
),
|
||||
left: tokenLine(WETH, "WETH"),
|
||||
spent: "1.0000 WETH",
|
||||
},
|
||||
{
|
||||
kind: "a WRAP_ETH of 1 ETH into the router, then a V3 swap of 1 WETH that the user pays for",
|
||||
@@ -1256,7 +705,6 @@ describe("any token left in the router is not received", () => {
|
||||
v3SwapExactIn(MSG_SENDER, ONE_WETH, USDC_1990, WETH, USDC),
|
||||
),
|
||||
left: tokenLine(WETH, "WETH"),
|
||||
spent: "1.0000 WETH",
|
||||
},
|
||||
{
|
||||
kind: "a WRAP_ETH of 1 ETH into the router, then a V4 swap of 1 WETH with a SETTLE of 1 WETH by the user",
|
||||
@@ -1269,7 +717,6 @@ describe("any token left in the router is not received", () => {
|
||||
),
|
||||
),
|
||||
left: tokenLine(WETH, "WETH"),
|
||||
spent: "1.0000 WETH",
|
||||
},
|
||||
{
|
||||
kind: "a swap paying WETH to the router, a WRAP_ETH of 1 ETH into the router, then a swap of 1 WETH from the router",
|
||||
@@ -1345,13 +792,9 @@ describe("any token left in the router is not received", () => {
|
||||
),
|
||||
),
|
||||
left: tokenLine(WETH, "WETH"),
|
||||
// The step has two SETTLEs of WETH, so what the user pays is not
|
||||
// known.
|
||||
spent: UNDECODED,
|
||||
},
|
||||
// The user pays for the swap by a SETTLE_ALL or SETTLE whose currency
|
||||
// the decoder cannot read, so the SETTLE from the router pays nothing,
|
||||
// and what the user pays is not known.
|
||||
// the decoder cannot read, so the SETTLE from the router pays nothing.
|
||||
{
|
||||
kind: "a WRAP_ETH of 1 ETH into the router, then a V4 swap of 1 WETH with a SETTLE_ALL that cannot be read and a SETTLE of OPEN_DELTA from the router",
|
||||
data: execute(
|
||||
@@ -1364,7 +807,6 @@ describe("any token left in the router is not received", () => {
|
||||
),
|
||||
),
|
||||
left: tokenLine(WETH, "WETH"),
|
||||
unread: true,
|
||||
},
|
||||
{
|
||||
kind: "a WRAP_ETH of 1 ETH into the router, then a V4 swap of 1 WETH with a SETTLE by the user that cannot be read and a SETTLE of OPEN_DELTA from the router",
|
||||
@@ -1378,7 +820,6 @@ describe("any token left in the router is not received", () => {
|
||||
),
|
||||
),
|
||||
left: tokenLine(WETH, "WETH"),
|
||||
unread: true,
|
||||
},
|
||||
{
|
||||
kind: "a WRAP_ETH of 1 ETH into the router, then a V4 step with an exact-in of 1 WETH less 1,000 wei and an empty path, a swap of 1,000 wei, and a SETTLE of OPEN_DELTA from the router",
|
||||
@@ -1432,20 +873,12 @@ describe("any token left in the router is not received", () => {
|
||||
),
|
||||
left: { label: "Token moved into the router", value: "ETH" },
|
||||
},
|
||||
])("$kind", ({ data, left, spent, unread }) => {
|
||||
])("$kind", ({ data, left }) => {
|
||||
const result = decode(data);
|
||||
expect(labels(result)).toEqual([
|
||||
"Protocol",
|
||||
"Token In",
|
||||
// A later step whose SETTLE or SETTLE_ALL the decoder cannot read
|
||||
// may take anything from the sender: one line says so, in place
|
||||
// of the Amount line (https://git.eeqj.de/sneak/AutistMask/issues/625).
|
||||
unread ? "Moved from the sender" : "Amount",
|
||||
// A later swap step the user pays for spends `spent` of a token
|
||||
// other than Token In.
|
||||
...(spent
|
||||
? ["Moved from the sender", "Token moved", "Moved to"]
|
||||
: []),
|
||||
"Amount",
|
||||
"Token Out",
|
||||
"Paid to",
|
||||
"Token moved into the router",
|
||||
@@ -1453,14 +886,6 @@ describe("any token left in the router is not received", () => {
|
||||
"Steps",
|
||||
"Deadline",
|
||||
]);
|
||||
if (spent) {
|
||||
expect(detail(result, "Moved from the sender").value).toBe(spent);
|
||||
}
|
||||
if (unread) {
|
||||
expect(detail(result, "Moved from the sender").value).toBe(
|
||||
UNDECODED,
|
||||
);
|
||||
}
|
||||
expect(paidTo(result)).toEqual([STAYS_IN_ROUTER]);
|
||||
expect(detail(result, "Token moved into the router")).toEqual(left);
|
||||
expect(detail(result, "Min. paid out").value).toBe("1990.0000 USDC");
|
||||
@@ -2071,6 +1496,15 @@ describe("a payout of part of the router's output", () => {
|
||||
),
|
||||
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",
|
||||
data: execute(
|
||||
@@ -2559,6 +1993,10 @@ describe("a payout that cannot be read is never said to be received", () => {
|
||||
),
|
||||
],
|
||||
},
|
||||
{
|
||||
kind: "V3_SWAP_EXACT_OUT",
|
||||
step: [0x01, swapToWeth(OTHER)[1]],
|
||||
},
|
||||
{
|
||||
kind: "EXECUTE_SUB_PLAN",
|
||||
step: [
|
||||
@@ -2809,7 +2247,7 @@ describe("the allow-revert flag", () => {
|
||||
mark: " (allowed to fail)",
|
||||
},
|
||||
])(
|
||||
"on $router, a PERMIT2_PERMIT with the flag is listed as 'Permit2 Permit$mark', and the swap's lines read as without the flag",
|
||||
"on $router, a PERMIT2_PERMIT with the flag is listed as 'Permit2 Permit$mark', and the swap reads as without the flag",
|
||||
({ address, mark }) => {
|
||||
const steps = [
|
||||
permit2Permit(USDT, USDT_2000),
|
||||
@@ -2824,24 +2262,9 @@ describe("the allow-revert flag", () => {
|
||||
expect(detail(withFlag, "Steps").value).toBe(
|
||||
"Permit2 Permit" + mark + " → V3 Swap (Exact In)",
|
||||
);
|
||||
// The permit names the router at ROUTER as its spender, so its
|
||||
// amount stands as the Amount figure only there, and only without
|
||||
// the flag. With the flag it stands on no router and gets lines
|
||||
// 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);
|
||||
const withoutSteps = (r) =>
|
||||
r.details.filter((d) => d.label !== "Steps");
|
||||
expect(withoutSteps(withFlag)).toEqual(withoutSteps(plain));
|
||||
expect(detail(withFlag, "Min. received").value).toBe("1.0000 WETH");
|
||||
},
|
||||
);
|
||||
|
||||
@@ -7,12 +7,6 @@
|
||||
// only when the transaction is sent to a Universal Router deployment on the
|
||||
// network it is for; anywhere else it is left to the raw data.
|
||||
//
|
||||
// The transaction history labelled any call named `execute` or `multicall` a
|
||||
// Swap, whatever address it went to
|
||||
// (https://git.eeqj.de/sneak/AutistMask/issues/580). It now does so only for
|
||||
// such a call sent to a Universal Router deployment on the network the
|
||||
// transaction is on; any other is labelled by its method name.
|
||||
//
|
||||
// The transaction detail screen and the approval screen are driven against a
|
||||
// minimal DOM stub in the shape tests/tokenTransferDetail.test.js uses, the
|
||||
// approval screen opened the way tests/swapStatusAmount.test.js opens it.
|
||||
@@ -39,7 +33,6 @@ globalThis.chrome = {
|
||||
};
|
||||
|
||||
const { state } = require("../src/shared/state");
|
||||
const { fetchRecentTransactions } = require("../src/shared/transactions");
|
||||
const approval = require("../src/popup/views/approval");
|
||||
const { decodeCalldata } = approval;
|
||||
const transactionDetail = require("../src/popup/views/transactionDetail");
|
||||
@@ -54,8 +47,6 @@ const SEPOLIA_ROUTER = "0x3a9d48ab9751398bbfa63ad67599bb04e4bdf98b";
|
||||
const ROUTER_ON_BOTH = "0x3fC91A3afd70395Cd496C647d5a6CC9D4B2b7FAD";
|
||||
// The address with no code from the issue.
|
||||
const ORDINARY = "0x0b0050Da68435b3EcBC236c40F16dB2070bCD79A";
|
||||
// A contract that is not a router, such as a multisig.
|
||||
const OTHER_CONTRACT = "0x5afe000000000000000000000000000000005afe";
|
||||
|
||||
const RECIPIENT = "0xC0FfEE0000000000000000000000000000c0fFEe";
|
||||
const SEPOLIA_WETH = "0xfFf9976782d46CC05630D1f6eBAb18b2324d6B14";
|
||||
@@ -138,13 +129,8 @@ describe("execute() calldata on the approval screen's decoder", () => {
|
||||
// The transaction the explorer reports: SWAP_DATA, sent to `mockSentTo`.
|
||||
const TX_HASH = "0x" + "5".repeat(64);
|
||||
let mockSentTo = null;
|
||||
// The transactions the explorer reports for RECIPIENT's history.
|
||||
let mockHistory = [];
|
||||
|
||||
function mockExplorerAnswer(url) {
|
||||
if (url.endsWith("/addresses/" + RECIPIENT + "/transactions")) {
|
||||
return { items: mockHistory };
|
||||
}
|
||||
if (url.endsWith("/transactions/" + TX_HASH)) {
|
||||
return {
|
||||
to: { hash: mockSentTo },
|
||||
@@ -201,9 +187,10 @@ function node(id) {
|
||||
}
|
||||
|
||||
// Open the transaction detail screen with `activeNetworkId` active, for the
|
||||
// history row `row`, and wait for its decoded details.
|
||||
async function showDetail(row, activeNetworkId) {
|
||||
mockSentTo = row.to;
|
||||
// Sepolia transaction the explorer reports sent to `sentTo`, and wait for its
|
||||
// decoded details.
|
||||
async function showDetailSentTo(sentTo, activeNetworkId) {
|
||||
mockSentTo = sentTo;
|
||||
globalThis.document = makeDocument();
|
||||
globalThis.window = { location: { search: "" } };
|
||||
state.networkId = activeNetworkId;
|
||||
@@ -211,32 +198,22 @@ async function showDetail(row, activeNetworkId) {
|
||||
state.viewData = {};
|
||||
state.viewStack = [];
|
||||
state.currentView = null;
|
||||
transactionDetail.show(row);
|
||||
transactionDetail.show({
|
||||
hash: TX_HASH,
|
||||
from: RECIPIENT,
|
||||
to: sentTo,
|
||||
value: "",
|
||||
symbol: "SepoliaETH",
|
||||
timestamp: 1790000000,
|
||||
isError: false,
|
||||
direction: "contract",
|
||||
directionLabel: "Swap",
|
||||
method: "execute",
|
||||
chainId: SEPOLIA,
|
||||
});
|
||||
for (let i = 0; i < 10; i++) await new Promise((r) => setTimeout(r, 0));
|
||||
}
|
||||
|
||||
// Open the transaction detail screen with `activeNetworkId` active, for the
|
||||
// Sepolia transaction the explorer reports sent to `sentTo`, and wait for its
|
||||
// decoded details.
|
||||
async function showDetailSentTo(sentTo, activeNetworkId) {
|
||||
await showDetail(
|
||||
{
|
||||
hash: TX_HASH,
|
||||
from: RECIPIENT,
|
||||
to: sentTo,
|
||||
value: "",
|
||||
symbol: "SepoliaETH",
|
||||
timestamp: 1790000000,
|
||||
isError: false,
|
||||
direction: "contract",
|
||||
directionLabel: "Swap",
|
||||
method: "execute",
|
||||
chainId: SEPOLIA,
|
||||
},
|
||||
activeNetworkId,
|
||||
);
|
||||
}
|
||||
|
||||
describe("execute() calldata on the transaction detail screen", () => {
|
||||
test("sent to a router on the active network, it is a swap", async () => {
|
||||
await showDetailSentTo(SEPOLIA_ROUTER, "sepolia");
|
||||
@@ -268,58 +245,6 @@ describe("execute() calldata on the transaction detail screen", () => {
|
||||
});
|
||||
});
|
||||
|
||||
// The history row made from the explorer's answer for RECIPIENT's `method`
|
||||
// call sent to the contract `sentTo` on the network with `chainId`. The
|
||||
// explorer gives the address in checksummed form.
|
||||
async function historyRow(method, sentTo, chainId) {
|
||||
mockHistory = [
|
||||
{
|
||||
hash: TX_HASH,
|
||||
block_number: 7000000,
|
||||
timestamp: "2026-09-01T00:00:00Z",
|
||||
from: { hash: RECIPIENT },
|
||||
to: { hash: getAddress(sentTo), is_contract: true },
|
||||
value: "0",
|
||||
method,
|
||||
status: "ok",
|
||||
},
|
||||
];
|
||||
const rows = await fetchRecentTransactions(
|
||||
RECIPIENT,
|
||||
"https://explorer.example/api/v2",
|
||||
chainId,
|
||||
);
|
||||
return rows[0];
|
||||
}
|
||||
|
||||
// The history row's label and TransactionDetail's Type line, for a Sepolia
|
||||
// transaction. The active network does not decide either.
|
||||
describe.each([
|
||||
["execute", "Execute"],
|
||||
["multicall", "Multicall"],
|
||||
])("a %s() call in the history", (method, methodLabel) => {
|
||||
test("sent to a router on its network, it is a Swap", async () => {
|
||||
const row = await historyRow(method, SEPOLIA_ROUTER, SEPOLIA);
|
||||
expect(row.directionLabel).toBe("Swap");
|
||||
await showDetail(row, "mainnet");
|
||||
expect(node("tx-detail-type").textContent).toBe("Swap");
|
||||
});
|
||||
|
||||
test("sent to another contract, it is labelled by its method name", async () => {
|
||||
const row = await historyRow(method, OTHER_CONTRACT, SEPOLIA);
|
||||
expect(row.directionLabel).toBe(methodLabel);
|
||||
await showDetail(row, "sepolia");
|
||||
expect(node("tx-detail-type").textContent).toBe("Contract Call");
|
||||
});
|
||||
|
||||
test("sent to a router of the other network only, it is labelled by its method name", async () => {
|
||||
const row = await historyRow(method, MAINNET_ROUTER, SEPOLIA);
|
||||
expect(row.directionLabel).toBe(methodLabel);
|
||||
await showDetail(row, "mainnet");
|
||||
expect(node("tx-detail-type").textContent).toBe("Contract Call");
|
||||
});
|
||||
});
|
||||
|
||||
// Open the approval screen with Ethereum Mainnet active, for a site's Sepolia
|
||||
// transaction that sends SWAP_DATA to `sentTo`.
|
||||
async function showApprovalSentTo(sentTo) {
|
||||
|
||||
@@ -120,7 +120,7 @@ global.document = {
|
||||
body: { prepend() {}, appendChild() {} },
|
||||
addEventListener() {},
|
||||
};
|
||||
global.navigator.clipboard = { writeText() {} };
|
||||
global.navigator = { clipboard: { writeText() {} } };
|
||||
|
||||
const { AbiCoder, parseUnits } = require("ethers");
|
||||
const { fetchTokenBalances } = require("../src/shared/balances");
|
||||
|
||||
Reference in New Issue
Block a user