Compare commits
7
Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
1e8691a3f6 | ||
|
|
c0a3a02418 | ||
|
|
f550d8c8d2 | ||
|
|
fc6cffcaba | ||
|
|
5615b08760 | ||
|
|
ec6b6b57a3 | ||
|
|
36b200247a |
@@ -1266,7 +1266,8 @@ see Transaction Decoding), do not always read as a number. They can read:
|
||||
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.
|
||||
its `amountOut`, the exact amount it buys. When earlier swap steps also pay
|
||||
that token to the user, the line shows the sum (see Transaction Decoding).
|
||||
- `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
|
||||
@@ -1277,22 +1278,18 @@ see Transaction Decoding), do not always read as a number. They can read:
|
||||
step pays nothing itself and swaps whatever an earlier step sent to the pair,
|
||||
so the calldata states no quantity. A V3 exact-in `amountIn` of zero has no
|
||||
such meaning and is shown as a zero.
|
||||
- `None (no minimum guaranteed)`: the swap's `Min. received` line, when the
|
||||
minimum it shows is zero, whether a V2, V3 or V4 swap's minimum or a
|
||||
`BALANCE_CHECK_ERC20` step's `minBalance`. Before
|
||||
[#359](https://git.eeqj.de/sneak/AutistMask/issues/359), a zero `minBalance`
|
||||
read `0.0000` when the token's scale was known. The router passes a balance
|
||||
check whenever the balance is at least `minBalance`, so a zero `minBalance`
|
||||
guarantees nothing: it sets `Token Out` and `Min. received` only when the
|
||||
output side holds no minimum, not even a zero one, at the point the check is
|
||||
reached, and otherwise leaves the current token and figure in place. A nonzero
|
||||
`minBalance` sets both lines, as a swap step does. Only a check of the
|
||||
transaction's sender's own balance sets either line; a check of any other
|
||||
address sets neither (see Transaction Decoding). A `BALANCE_CHECK_ERC20` step
|
||||
that the router lets fail without reverting the transaction (see Transaction
|
||||
Decoding) guarantees nothing either, whatever its `minBalance`, and is read as
|
||||
one whose `minBalance` is zero. A minimum stated by a V4 swap step the router
|
||||
lets fail is likewise read as zero.
|
||||
- `None (no minimum guaranteed)`: the swap's `Min. received` line, when it shows
|
||||
a V2, V3 or V4 swap's minimum of zero. The router passes a
|
||||
`BALANCE_CHECK_ERC20` step whenever the balance is at least `minBalance`, so a
|
||||
zero `minBalance` guarantees nothing. A check with a zero `minBalance` sets
|
||||
neither `Token Out` nor `Min. received`. A nonzero `minBalance` sets both
|
||||
lines, as a swap step does. Only a check of the transaction's sender's own
|
||||
balance sets either line; a check of any other address sets neither (see
|
||||
Transaction Decoding). A `BALANCE_CHECK_ERC20` step that the router lets fail
|
||||
without reverting the transaction (see Transaction Decoding) guarantees
|
||||
nothing either, whatever its `minBalance`, and is read as one whose
|
||||
`minBalance` is zero. A minimum stated by a V4 swap step the router lets fail
|
||||
is likewise read as zero.
|
||||
|
||||
The swap's `Token In` and `Token Out` lines name a currency, not an amount; each
|
||||
reads `Unknown (not named in the calldata)` when the decoder found no token for
|
||||
@@ -2281,6 +2278,8 @@ view would leave a wallet one click from deletion.
|
||||
- Endpoint URL input + "Save" button. "Save" asks the URL for `/stats`
|
||||
and saves the URL only if that request succeeds. The request carries
|
||||
no user data and is made whether or not "Use Blockscout" is ticked.
|
||||
- If the network changes before either "Save" stores its URL, the URL is not
|
||||
saved and a flash message says so
|
||||
- Etherscan:
|
||||
- "Check recipients on Etherscan" checkbox, unticked until the user
|
||||
ticks it
|
||||
@@ -3395,7 +3394,8 @@ Currently supported:
|
||||
`Balance Check (of another address)`. A check whose input does not decode,
|
||||
such as one whose owner word has a nonzero top byte (the router reads the
|
||||
owner from the word's last 20 bytes), likewise sets neither, and it is listed
|
||||
as `Balance Check (could not be decoded)`. When a swap step, `TAKE` or
|
||||
as `Balance Check (could not be decoded)`. A check with a zero `minBalance`
|
||||
sets neither `Token Out` nor the minimum. When a swap step, `TAKE` or
|
||||
`TAKE_PORTION` pays the router any token, the swap's output or another, a
|
||||
`WRAP_ETH` pays it WETH, or an `UNWRAP_WETH` into the router turns WETH a step
|
||||
paid it into ETH, that token stays in the router unless a later step pays out
|
||||
@@ -3460,136 +3460,160 @@ 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
|
||||
minimum reads `Min. paid out`. The step that sets the output side gives the
|
||||
minimum. When that step and earlier swap steps each pay the output token to
|
||||
the transaction's sender, the minimum is the sum of their minimums. There is
|
||||
no minimum when the decoder reads none from one of them, or when one of them
|
||||
pays part of that token elsewhere. There is also no minimum when the decoder
|
||||
did not read one of them, or a step between them, in full. A swap step that
|
||||
spends the output token drops earlier steps from the sum. A V4 step spends
|
||||
each token that its swap actions spend. A V4 `SETTLE` or `SETTLE_ALL` of the
|
||||
output token also drops earlier steps. A `PERMIT2_TRANSFER_FROM` of the output
|
||||
token drops earlier steps too. A step after the step that sets the output side
|
||||
drops nothing from the sum. 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 and there is no `PERMIT2_PERMIT_BATCH`, its spender is the router,
|
||||
the router may not let it fail, no step before it takes its token, a
|
||||
`PERMIT2_TRANSFER_FROM` of it included, 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 before the permit takes under whatever allowance the router
|
||||
already had, so it may take more than the permit's amount, which would then
|
||||
read lower than what leaves the user's wallet: a `PERMIT2_TRANSFER_FROM` of
|
||||
2,000 USDT into the router, then a permit of 600 USDT to the router and a V3
|
||||
exact-in of 2,000 USDT paid from the router, read `Amount 2000.0000 USDT`. A
|
||||
later permit or batch may raise what Permit2 lets the router take, and so may
|
||||
a step the decoder does not read in full: 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, unless it lets a spender other than
|
||||
the router take `Token In` (see below): 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 there is no `Amount` line, each
|
||||
take the total counts gets them too, so that every amount the decoder reads is
|
||||
shown: the amount the step that sets the input side states, when it is a
|
||||
quantity and the user pays that step (a V2 or V3 step whose `payerIsUser` is
|
||||
true, a V4 step the user pays some of its input token, or a `WRAP_ETH`, whose
|
||||
ETH comes from the transaction's value), and each later take of `Token In`
|
||||
added to it. A step that sets the input side and is paid from the router takes
|
||||
nothing from the user's wallet and gets none. A `PERMIT2_PERMIT` the decoder
|
||||
cannot read, then V3 exact-ins of 600 USDT and 400 DAI paid by the user, give
|
||||
lines for both amounts. When the step that sets the input side states no
|
||||
amount, the user pays it some of its input token, and there is no `Amount`
|
||||
line, that step gets them too whenever another take's lines give a figure, or
|
||||
a `PERMIT2_TRANSFER_FROM` of its token gives one, on the lines below or, into
|
||||
the router, on its `Paid to` line, so that figure cannot read as all that
|
||||
leaves. When it states no amount and the user pays it none of its input token,
|
||||
as when the router pays it, that step takes none of that token from the user's
|
||||
wallet and never gets them, with a permit or without. They come in step order,
|
||||
except that the step that sets the input side comes first when it has them,
|
||||
followed, when there is no `Amount` line, by the other takes the total counts:
|
||||
`Moved from the sender`, its amount, worded as the `Amount` line words one, or
|
||||
`Unknown (could not be decoded)` when the decoder does not know it;
|
||||
`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
|
||||
rest taken to another address, reads `5000.0000 USDT`. A later step that pays
|
||||
an ERC-20 token from the router takes none of that token from the user's
|
||||
wallet. A V2 exact-in whose `amountIn` is `ALREADY_PAID` takes nothing either.
|
||||
A V4 `SETTLE` of ETH paid from the router still takes from the user's wallet,
|
||||
since the router holds the transaction's value. When the decoder does not know
|
||||
the amount of such a `SETTLE`, as for `CONTRACT_BALANCE`, that `SETTLE` counts
|
||||
as a later step's take. When an earlier step left ETH in the router, that ETH
|
||||
may pay part of a `SETTLE` of ETH paid from the router. That `SETTLE` then
|
||||
gets lines of its own, with `Up to` before its amount. A later take of
|
||||
`Token In` that only the user's wallet pays 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 and there is no
|
||||
`PERMIT2_PERMIT_BATCH`, its spender is the router, the router may not let it
|
||||
fail, no step before it takes its token, a `PERMIT2_TRANSFER_FROM` of it
|
||||
included, 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 before the
|
||||
permit takes under whatever allowance the router already had, so it may take
|
||||
more than the permit's amount, which would then read lower than what leaves
|
||||
the user's wallet: a `PERMIT2_TRANSFER_FROM` of 2,000 USDT into the router,
|
||||
then a permit of 600 USDT to the router and a V3 exact-in of 2,000 USDT paid
|
||||
from the router, read `Amount 2000.0000 USDT`. A later permit or batch may
|
||||
raise what Permit2 lets the router take, and so may a step the decoder does
|
||||
not read in full: 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, unless it lets a spender other than the router take `Token In`
|
||||
(see below): 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. A permit on the
|
||||
zero address never stands as the `Amount` figure, because Permit2 has no
|
||||
allowance of ETH. 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);
|
||||
an ETH take whose line reads `Up to` (see above); and one whose amount the
|
||||
decoder does not know. When there is no `Amount` line, each take the total
|
||||
counts gets them too, so that every amount the decoder reads is shown: the
|
||||
amount the step that sets the input side states, when it is a quantity and the
|
||||
user pays that step (a V2 or V3 step whose `payerIsUser` is true, a V4 step
|
||||
the user pays some of its input token, or a `WRAP_ETH`, whose ETH comes from
|
||||
the transaction's value), and each later take of `Token In` added to it. A
|
||||
step that sets the input side gets none when the user pays it none of its
|
||||
input token. A `PERMIT2_PERMIT` the decoder cannot read, then V3 exact-ins of
|
||||
600 USDT and 400 DAI paid by the user, give lines for both amounts. When the
|
||||
step that sets the input side states no amount, the user pays it some of its
|
||||
input token, and there is no `Amount` line, that step gets them too whenever
|
||||
another take's lines give a figure, or a `PERMIT2_TRANSFER_FROM` of its token
|
||||
gives one, on the lines below or, into the router, on its `Paid to` line, so
|
||||
that figure cannot read as all that leaves. When it states no amount and the
|
||||
user pays it none of its input token, that step never gets them, with a permit
|
||||
or without. They come in step order, except that the step that sets the input
|
||||
side comes first when it has them, followed, when there is no `Amount` line,
|
||||
by the other takes the total counts: `Moved from the sender`, its amount,
|
||||
worded as the `Amount` line words one, or `Unknown (could not be decoded)`
|
||||
when the decoder does not know it; `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
|
||||
`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
|
||||
where it goes, and so its amount is shown once. For a move of the zero
|
||||
address, `Moved from the sender` gives the amount in base units and
|
||||
`Token moved` gives the zero address. For such a move into the router, the
|
||||
`Paid to` line gives the amount in base units and
|
||||
`Token moved into the router` gives the zero address. 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. Each allowance a `PERMIT2_PERMIT_BATCH`
|
||||
grants, one for each token it names, all for its one spender, gives the same
|
||||
three lines, in step order with those of each `PERMIT2_PERMIT`. A
|
||||
`PERMIT2_PERMIT` or `PERMIT2_PERMIT_BATCH` whose input the decoder cannot
|
||||
read, such as one whose token or spender word has a nonzero top byte, may let
|
||||
any spender take any amount of any token: it gives one `Permit2 allowance`
|
||||
line alone, reading `Unknown (could not be decoded)`. These lines change no
|
||||
`Paid to` line: a permit or batch pays nobody. But code that a step runs, such
|
||||
as a V4 pool's hook or a token's own code, can call a spender other than the
|
||||
router, which can then take up to its allowance from the user's wallet before
|
||||
the transaction ends. So an allowance to any spender but the router, or a
|
||||
permit or batch the decoder cannot read, makes the minimum read
|
||||
`Min. paid out`, and when its token is `Token In`, or the decoder does not
|
||||
know its token or `Token In`, it leaves no `Amount` line, whose figure might
|
||||
be too low: a permit of 5,000 USDT to another address and then a V3 exact-in
|
||||
of 600 USDT read with no `Amount` line, and the 600 USDT gets lines of its
|
||||
own. A step goes unread when its recipient does not decode as an address, when
|
||||
it is a V3 swap step whose path is shorter than one token address or has bytes
|
||||
after its last hop, or when it is a command the decoder does not read: every
|
||||
command other than `PERMIT2_PERMIT`, `PERMIT2_PERMIT_BATCH`,
|
||||
`PERMIT2_TRANSFER_FROM`, `V2_SWAP_EXACT_IN`, `V2_SWAP_EXACT_OUT`,
|
||||
`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.
|
||||
three lines, in step order with those of each `PERMIT2_PERMIT`. For an
|
||||
allowance of the zero address, `Permit2 allowance` gives the amount in base
|
||||
units and `Allowance token` gives the zero address. A `PERMIT2_PERMIT` or
|
||||
`PERMIT2_PERMIT_BATCH` whose input the decoder cannot read, such as one whose
|
||||
token or spender word has a nonzero top byte, may let any spender take any
|
||||
amount of any token: it gives one `Permit2 allowance` line alone, reading
|
||||
`Unknown (could not be decoded)`. These lines change no `Paid to` line: a
|
||||
permit or batch pays nobody. But code that a step runs, such as a V4 pool's
|
||||
hook or a token's own code, can call a spender other than the router, which
|
||||
can then take up to its allowance from the user's wallet before the
|
||||
transaction ends. So an allowance to any spender but the router, or a permit
|
||||
or batch the decoder cannot read, makes the minimum read `Min. paid out`, and
|
||||
when its token is `Token In`, or the decoder does not know its token or
|
||||
`Token In`, it leaves no `Amount` line, whose figure might be too low: a
|
||||
permit of 5,000 USDT to another address and then a V3 exact-in of 600 USDT
|
||||
read with no `Amount` line, and the 600 USDT gets lines of its own. A step
|
||||
goes unread when its recipient does not decode as an address, when it is a V3
|
||||
swap step whose path is shorter than one token address or has bytes after its
|
||||
last hop, or when it is a command the decoder does not read: every command
|
||||
other than `PERMIT2_PERMIT`, `PERMIT2_PERMIT_BATCH`, `PERMIT2_TRANSFER_FROM`,
|
||||
`V2_SWAP_EXACT_IN`, `V2_SWAP_EXACT_OUT`, `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.
|
||||
|
||||
### Non-Goals Forever
|
||||
|
||||
|
||||
@@ -44,6 +44,12 @@ let ctx;
|
||||
let versionClickCount = 0;
|
||||
let versionClickTimer = null;
|
||||
|
||||
// The network that Settings was last drawn for. A follow of a switch saved
|
||||
// elsewhere sets `state` to the new network first. Settings is drawn again only
|
||||
// once the follow's write returns. So both "Save" buttons take this network,
|
||||
// not the one in `state`.
|
||||
let shownNetwork = null;
|
||||
|
||||
// One row per site origin, however many addresses it appears under, each with
|
||||
// an [x] that hands it to onRemove.
|
||||
function renderSiteList(containerId, origins, onRemove) {
|
||||
@@ -199,6 +205,7 @@ function renderWalletListSettings() {
|
||||
}
|
||||
|
||||
function show() {
|
||||
shownNetwork = currentNetwork();
|
||||
$("settings-rpc").value = state.rpcUrl;
|
||||
$("settings-blockscout").value = state.blockscoutUrl;
|
||||
$("settings-network").value = state.networkId;
|
||||
@@ -306,6 +313,7 @@ function showNewSettings() {
|
||||
state.checkRecipientsOnEtherscan;
|
||||
if (state.currentView === "settings") {
|
||||
markViewRendered("settings");
|
||||
shownNetwork = currentNetwork();
|
||||
$("settings-network").value = state.networkId;
|
||||
$("settings-rpc").value = state.rpcUrl;
|
||||
$("settings-blockscout").value = state.blockscoutUrl;
|
||||
@@ -319,6 +327,28 @@ function showNewSettings() {
|
||||
updateDebugBanner(state.currentView);
|
||||
}
|
||||
|
||||
// Saves `url` as `field` ("rpcUrl" or "blockscoutUrl") of the network
|
||||
// `networkId`, the one that Settings showed when the user tapped "Save". The
|
||||
// URL is set in `state` inside the save, holding the lock. So the page cannot
|
||||
// follow a switch saved elsewhere (followStoredSettings() in
|
||||
// src/popup/index.js) between setting the URL and writing it. If the active
|
||||
// network is no longer `networkId`, on this page or in the stored record,
|
||||
// nothing is saved. The flash message then says that the network changed.
|
||||
async function saveEndpoint(field, url, networkId) {
|
||||
let refused = false;
|
||||
await saveState((stored) => {
|
||||
refused =
|
||||
state.networkId !== networkId || stored.networkId !== networkId;
|
||||
if (refused) return false;
|
||||
state[field] = url;
|
||||
});
|
||||
if (refused) {
|
||||
showFlash("The URL was not saved because the network changed.");
|
||||
} else {
|
||||
showFlash("Saved.");
|
||||
}
|
||||
}
|
||||
|
||||
function init(_ctx) {
|
||||
ctx = _ctx;
|
||||
deleteWallet.init(ctx);
|
||||
@@ -330,6 +360,8 @@ function init(_ctx) {
|
||||
showFlash("Please enter an RPC URL.");
|
||||
return;
|
||||
}
|
||||
// The URL is for the network that Settings shows when "Save" is tapped.
|
||||
const net = shownNetwork;
|
||||
showFlash("Testing endpoint...");
|
||||
try {
|
||||
const resp = await debugFetch(url, {
|
||||
@@ -348,7 +380,6 @@ function init(_ctx) {
|
||||
showFlash("Endpoint returned an error.");
|
||||
return;
|
||||
}
|
||||
const net = currentNetwork();
|
||||
if (json.result !== net.chainId) {
|
||||
showFlash("Wrong network: expected " + net.name + ".");
|
||||
return;
|
||||
@@ -364,9 +395,7 @@ function init(_ctx) {
|
||||
showFlash("Could not reach endpoint.");
|
||||
return;
|
||||
}
|
||||
state.rpcUrl = url;
|
||||
await saveState();
|
||||
showFlash("Saved.");
|
||||
await saveEndpoint("rpcUrl", url, net.id);
|
||||
});
|
||||
|
||||
$("btn-save-blockscout").addEventListener("click", async () => {
|
||||
@@ -375,6 +404,7 @@ function init(_ctx) {
|
||||
showFlash("Please enter a Blockscout API URL.");
|
||||
return;
|
||||
}
|
||||
const net = shownNetwork;
|
||||
showFlash("Testing endpoint...");
|
||||
try {
|
||||
const resp = await debugFetch(url + "/stats");
|
||||
@@ -389,9 +419,7 @@ function init(_ctx) {
|
||||
showFlash("Could not reach endpoint.");
|
||||
return;
|
||||
}
|
||||
state.blockscoutUrl = url;
|
||||
await saveState();
|
||||
showFlash("Saved.");
|
||||
await saveEndpoint("blockscoutUrl", url, net.id);
|
||||
});
|
||||
|
||||
// Each change is made inside the save, holding the lock. So
|
||||
|
||||
@@ -47,12 +47,30 @@ function clearPopupCaches() {
|
||||
// lock, so it is never switched while a follow of a switch saved elsewhere
|
||||
// waits for the lock (followStoredSettings() in src/popup/index.js): that
|
||||
// follow runs first, and this switch is made after it.
|
||||
//
|
||||
// The save writes only the fields that differ from what this page last saved.
|
||||
// When this page last saved a balance of "0", clearing that balance is no
|
||||
// change. So the switch also resets these fields in the stored record:
|
||||
//
|
||||
// - every address's balance and token balances;
|
||||
// - the time of the last balance refresh.
|
||||
//
|
||||
// A balance that the background or another page stored since this page's last
|
||||
// save is then not kept under the new network
|
||||
// (https://git.eeqj.de/sneak/AutistMask/issues/653).
|
||||
async function onChainSwitch(newNetworkId) {
|
||||
const { state, saveState } = require("./state");
|
||||
let net = null;
|
||||
await saveState(() => {
|
||||
await saveState((stored) => {
|
||||
if (state.networkId === newNetworkId) return false;
|
||||
net = applyChainSwitchFields(state, newNetworkId);
|
||||
stored.lastBalanceRefresh = 0;
|
||||
for (const wallet of stored.wallets) {
|
||||
for (const addr of wallet.addresses) {
|
||||
addr.balance = "0";
|
||||
addr.tokenBalances = [];
|
||||
}
|
||||
}
|
||||
clearPopupCaches();
|
||||
});
|
||||
return net;
|
||||
|
||||
+4
-2
@@ -591,8 +591,10 @@ function reportSaveFailure(err) {
|
||||
//
|
||||
// `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.
|
||||
// `state`, and this save writes that change. It may also change the stored
|
||||
// record. A field that this page did not change is then written as
|
||||
// `beforeWrite` left it. When it returns false, nothing is written; any other
|
||||
// return lets the save go ahead.
|
||||
function saveState(beforeWrite) {
|
||||
const turn = withLock("autistmask", () => saveStateOnce(beforeWrite));
|
||||
// Every failed save is reported, whether or not the caller awaited this
|
||||
|
||||
+245
-71
@@ -479,6 +479,17 @@ function tokenInfo(address, sources) {
|
||||
};
|
||||
}
|
||||
|
||||
// The token of a Permit2 allowance or of a PERMIT2_TRANSFER_FROM, in the
|
||||
// shape tokenInfo() gives. Permit2 has no allowance of ETH and moves no ETH.
|
||||
// The zero address there reads as a token nothing knows: its amount in base
|
||||
// units, and the zero address as its token.
|
||||
function permit2TokenInfo(address, sources) {
|
||||
if (address === "0x0000000000000000000000000000000000000000") {
|
||||
return { symbol: null, decimals: null, address };
|
||||
}
|
||||
return tokenInfo(address, sources);
|
||||
}
|
||||
|
||||
// A swap amount line. With a scale it is the token quantity; with none it is
|
||||
// the base-unit integer with the unknown scale stated, the same refusal the
|
||||
// ERC-20 amount line makes, so the screen has one way of saying it. `display`
|
||||
@@ -497,16 +508,18 @@ function amountText(raw, info) {
|
||||
|
||||
// The line giving a moved token, or the token of a permit, under `label`, in
|
||||
// the shape of the Token In line, so the screens show it as they show that
|
||||
// one. ETH has no address.
|
||||
function tokenMovedLine(label, token, sources) {
|
||||
const info = tokenInfo(token, sources);
|
||||
// one. `info` is what tokenInfo() or permit2TokenInfo() gives for the token.
|
||||
// ETH has no address.
|
||||
function tokenMovedLine(label, info) {
|
||||
if (!present(info.address)) {
|
||||
return { label, value: info.symbol };
|
||||
}
|
||||
return {
|
||||
label,
|
||||
value: info.symbol ? info.symbol + " (" + token + ")" : token,
|
||||
address: token,
|
||||
value: info.symbol
|
||||
? info.symbol + " (" + info.address + ")"
|
||||
: info.address,
|
||||
address: info.address,
|
||||
isToken: true,
|
||||
};
|
||||
}
|
||||
@@ -975,6 +988,9 @@ function totalAmount(amounts) {
|
||||
// pays it of Token In as the step's amount in place of the rules' Amount, or
|
||||
// no amount when this decoder cannot tell what that is.
|
||||
//
|
||||
// `spent` lists the currency that each swap action spends, for each swap
|
||||
// action that this decoder could read.
|
||||
//
|
||||
// `takes` is every TAKE, TAKE_ALL and TAKE_PORTION, as the currency it takes
|
||||
// and its recipient as written, MSG_SENDER for a TAKE_ALL. TAKE_PORTION takes
|
||||
// a share of the currency, so it does not name the output side as TAKE does.
|
||||
@@ -1150,6 +1166,8 @@ function decodeV4Swap(input) {
|
||||
}
|
||||
}
|
||||
|
||||
const spent = swaps.map((s) => s.tokenIn);
|
||||
|
||||
// Rule 3.
|
||||
if (swapUndecoded) {
|
||||
return {
|
||||
@@ -1157,6 +1175,7 @@ function decodeV4Swap(input) {
|
||||
tokenOut: takeToken,
|
||||
amountIn: null,
|
||||
amountOutMin: null,
|
||||
spent,
|
||||
takes,
|
||||
settledFromRouter,
|
||||
paidByUser,
|
||||
@@ -1167,7 +1186,6 @@ function decodeV4Swap(input) {
|
||||
};
|
||||
}
|
||||
|
||||
const spent = swaps.map((s) => s.tokenIn);
|
||||
const bought = swaps.map((s) => s.tokenOut);
|
||||
|
||||
// Rules 1 and 2 for Token In.
|
||||
@@ -1203,6 +1221,7 @@ function decodeV4Swap(input) {
|
||||
tokenOut,
|
||||
amountIn,
|
||||
amountOutMin,
|
||||
spent,
|
||||
takes,
|
||||
settledFromRouter,
|
||||
paidByUser,
|
||||
@@ -1240,9 +1259,10 @@ function decode(data, toAddress, chainId, sources, fromAddress) {
|
||||
let inputEstablished = false;
|
||||
// Whether the user pays the step that set the input side: a V2 or V3
|
||||
// swap step with `payerIsUser` true, a V4 step the user pays some of
|
||||
// its input currency (see decodeV4Swap()), or a WRAP_ETH, whose ETH
|
||||
// comes from the transaction's value. A step paid from the router
|
||||
// takes nothing from the sender.
|
||||
// its input currency (see paidByUser in the loop), or a WRAP_ETH,
|
||||
// whose ETH comes from the transaction's value. A step that pays an
|
||||
// ERC-20 token from the router takes none of that token from the
|
||||
// sender.
|
||||
let inputPaidByUser = false;
|
||||
// The last PERMIT2_PERMIT this decoder read before a step set the
|
||||
// input side, or null (see permitStands after the loop).
|
||||
@@ -1293,8 +1313,9 @@ function decode(data, toAddress, chainId, sources, fromAddress) {
|
||||
const commandNames = [];
|
||||
|
||||
// THE INVARIANT: an amount and the token it is counted in always come
|
||||
// from the same hop, or from hops that all spend that token. A figure
|
||||
// is never rendered against a token that did not supply it.
|
||||
// from the same hop, or from hops that all spend that token or all buy
|
||||
// it. A figure is never rendered against a token that did not supply
|
||||
// it.
|
||||
//
|
||||
// Both sides are therefore set as a PAIR — never field by field, and
|
||||
// never on truthiness. An address is never falsy once set but an
|
||||
@@ -1338,7 +1359,9 @@ function decode(data, toAddress, chainId, sources, fromAddress) {
|
||||
// What the steps take from the sender beyond the amount of the step
|
||||
// that sets the input side, as { token, amount }, in step order.
|
||||
// After the loop each joins the Amount line or gets lines of its own
|
||||
// (see permitStands).
|
||||
// (see permitStands). A take with `atMost` set may take less than
|
||||
// `amount`: it never joins the Amount line, and its line reads
|
||||
// "Up to" and the amount.
|
||||
const userPaid = [];
|
||||
// A swap step the user pays for (`payerIsUser` true) takes `amount`
|
||||
// of `token` from the sender. A V2 exact-in of ALREADY_PAID takes
|
||||
@@ -1407,6 +1430,10 @@ function decode(data, toAddress, chainId, sources, fromAddress) {
|
||||
const r = recipient.toLowerCase();
|
||||
return r === ADDRESS_THIS || r === toAddress.toLowerCase();
|
||||
};
|
||||
const isSender = (recipient) => {
|
||||
const r = recipient.toLowerCase();
|
||||
return r === MSG_SENDER || r === sender;
|
||||
};
|
||||
// A swap step or V4 SETTLE pays `amount` of `token` from the router's
|
||||
// own balance. CONTRACT_BALANCE pays all of it. Any other quantity
|
||||
// counts against the amount a WRAP_ETH stated, and the steps pay all
|
||||
@@ -1439,17 +1466,73 @@ function decode(data, toAddress, chainId, sources, fromAddress) {
|
||||
// A step pays `recipient`. `output` is the token a swap step or a V4
|
||||
// TAKE or TAKE_PORTION pays; other steps pass none.
|
||||
const addPayee = (recipient, output) => {
|
||||
const r = recipient.toLowerCase();
|
||||
if (isRouter(recipient)) {
|
||||
if (present(output)) {
|
||||
heldByRouter.set(output.toLowerCase(), null);
|
||||
}
|
||||
} else if (r === MSG_SENDER || r === sender) {
|
||||
} else if (isSender(recipient)) {
|
||||
paidToSender = true;
|
||||
} else {
|
||||
addPaidElsewhere(recipient);
|
||||
}
|
||||
};
|
||||
// Each swap step that paid the sender some of the token it bought,
|
||||
// as { step, token, amount, onlyToSender }:
|
||||
// - `step` is the step's index;
|
||||
// - `token` is that token;
|
||||
// - `amount` is the step's stated minimum;
|
||||
// - `onlyToSender` is whether the step paid all of that token to the
|
||||
// sender.
|
||||
// A later step that spends that token takes the step off this list
|
||||
// (see dropFromSum()).
|
||||
let swapsPayingSender = [];
|
||||
// The step being read spends `token`, so it may spend what an earlier
|
||||
// swap step paid the sender. Each step on swapsPayingSender that
|
||||
// bought `token` leaves the list. A step spends a token as follows:
|
||||
// - a V2 or V3 swap step spends its input token;
|
||||
// - a V4 step spends each token that one of its swap actions spends,
|
||||
// and each token that one of its SETTLEs or SETTLE_ALLs pays;
|
||||
// - a PERMIT2_TRANSFER_FROM spends the token it moves.
|
||||
const dropFromSum = (token) => {
|
||||
swapsPayingSender = swapsPayingSender.filter(
|
||||
(s) => !sameAddress(s.token, token),
|
||||
);
|
||||
};
|
||||
// The minimum the output side shows for the swap step at `step`. The
|
||||
// step buys `token` with the stated minimum `amount`, and pays
|
||||
// `token` to `recipients`. The minimum is the step's own, unless this
|
||||
// step and an earlier one on swapsPayingSender both pay `token` to
|
||||
// the sender, as a route split across steps does. The minimum is then
|
||||
// the total of all such steps' minimums. There is none when this
|
||||
// decoder reads no minimum from one of them, or when one of them pays
|
||||
// some of `token` elsewhere. There is also none when this decoder did
|
||||
// not read one of them, or a step between them, in full (see
|
||||
// stepsUnread).
|
||||
const swapMinimum = (step, token, amount, recipients) => {
|
||||
const toSender = recipients.filter(
|
||||
(r) => present(r) && isSender(r),
|
||||
);
|
||||
if (toSender.length === 0) return amount;
|
||||
swapsPayingSender.push({
|
||||
step,
|
||||
token,
|
||||
amount,
|
||||
onlyToSender: toSender.length === recipients.length,
|
||||
});
|
||||
const split = swapsPayingSender.filter((s) =>
|
||||
sameAddress(s.token, token),
|
||||
);
|
||||
if (split.length < 2) return amount;
|
||||
if (
|
||||
split.some(
|
||||
(s) => !s.onlyToSender || typeof s.amount !== "bigint",
|
||||
) ||
|
||||
stepsUnread.some((unread) => unread >= split[0].step)
|
||||
) {
|
||||
return null;
|
||||
}
|
||||
return split.reduce((sum, s) => sum + s.amount, 0n);
|
||||
};
|
||||
// A step that pays `token` to `recipient` is a hop, not a payout,
|
||||
// when the very next step is a V2 exact-in whose input is already
|
||||
// paid, whose path starts at `token`, and whose pair (see v2PairFor())
|
||||
@@ -1591,6 +1674,7 @@ function decode(data, toAddress, chainId, sources, fromAddress) {
|
||||
: null,
|
||||
});
|
||||
}
|
||||
if (p) dropFromSum(p.token);
|
||||
} else if (command === "BALANCE_CHECK_ERC20") {
|
||||
const b = decodeBalanceCheck(inputs[i]);
|
||||
if (!b) {
|
||||
@@ -1613,13 +1697,13 @@ function decode(data, toAddress, chainId, sources, fromAddress) {
|
||||
} else {
|
||||
// The router passes this check whenever the owner
|
||||
// holds at least minBalance, so a zero one guarantees
|
||||
// nothing and does not replace a minimum an earlier
|
||||
// step stated. A check the router lets fail guarantees
|
||||
// nothing either, so it is read as a zero one. Any
|
||||
// nothing. A check the router lets fail guarantees
|
||||
// nothing either, so it is read as a zero one. A zero
|
||||
// check sets neither Token Out nor the minimum. Any
|
||||
// other minBalance sets the output side as a swap
|
||||
// does. It pays nobody.
|
||||
// does. The check pays nobody.
|
||||
const minBalance = allowedToFail ? 0n : b.minBalance;
|
||||
if (!(minBalance === 0n && present(minOutput))) {
|
||||
if (minBalance !== 0n) {
|
||||
setOutput(i, b.token, minBalance, []);
|
||||
}
|
||||
keepsRouterWeth = true;
|
||||
@@ -1633,10 +1717,18 @@ function decode(data, toAddress, chainId, sources, fromAddress) {
|
||||
} else if (s.payerIsUser) {
|
||||
addUserPaid(s.tokenIn, s.amountIn);
|
||||
}
|
||||
dropFromSum(s.tokenIn);
|
||||
// Always update output: in multi-step swaps (V3 → V4),
|
||||
// the last swap step determines the final output token
|
||||
// and minimum received amount.
|
||||
setOutput(i, s.tokenOut, s.amountOutMin, [s.recipient]);
|
||||
// the last swap step determines the final output
|
||||
// token. swapMinimum() gives the minimum.
|
||||
setOutput(
|
||||
i,
|
||||
s.tokenOut,
|
||||
swapMinimum(i, s.tokenOut, s.amountOutMin, [
|
||||
s.recipient,
|
||||
]),
|
||||
[s.recipient],
|
||||
);
|
||||
if (!s.payerIsUser) {
|
||||
spendFromRouter(s.tokenIn, s.amountIn);
|
||||
}
|
||||
@@ -1657,7 +1749,15 @@ function decode(data, toAddress, chainId, sources, fromAddress) {
|
||||
} else if (s.payerIsUser) {
|
||||
addUserPaid(s.tokenIn, s.amountIn);
|
||||
}
|
||||
setOutput(i, s.tokenOut, s.amountOutMin, [s.recipient]);
|
||||
dropFromSum(s.tokenIn);
|
||||
setOutput(
|
||||
i,
|
||||
s.tokenOut,
|
||||
swapMinimum(i, s.tokenOut, s.amountOutMin, [
|
||||
s.recipient,
|
||||
]),
|
||||
[s.recipient],
|
||||
);
|
||||
if (!s.payerIsUser) {
|
||||
spendFromRouter(s.tokenIn, s.amountIn);
|
||||
}
|
||||
@@ -1689,7 +1789,15 @@ function decode(data, toAddress, chainId, sources, fromAddress) {
|
||||
} else if (s.payerIsUser) {
|
||||
addUserPaid(s.tokenIn, s.amountInMax);
|
||||
}
|
||||
setOutput(i, s.tokenOut, s.amountOut, [s.recipient]);
|
||||
dropFromSum(s.tokenIn);
|
||||
setOutput(
|
||||
i,
|
||||
s.tokenOut,
|
||||
swapMinimum(i, s.tokenOut, s.amountOut, [
|
||||
s.recipient,
|
||||
]),
|
||||
[s.recipient],
|
||||
);
|
||||
if (!isHop(i, s.tokenOut, s.recipient)) {
|
||||
addPayee(s.recipient, s.tokenOut);
|
||||
}
|
||||
@@ -1815,6 +1923,41 @@ function decode(data, toAddress, chainId, sources, fromAddress) {
|
||||
} else if (command === "V4_SWAP") {
|
||||
const v4 = decodeV4Swap(inputs[i]);
|
||||
const inputSetBefore = inputEstablished;
|
||||
// V4Router pays a SETTLE of ETH from the router's own
|
||||
// ETH, whichever payer the SETTLE names. The router holds
|
||||
// the transaction's value, and any ETH an earlier step
|
||||
// left it (see heldByRouter). So the user also pays a
|
||||
// SETTLE of ETH that names the router as payer. The user
|
||||
// pays all of its amount when the router holds no other
|
||||
// ETH, and up to its amount otherwise. CONTRACT_BALANCE
|
||||
// pays all the router holds, an amount the calldata does
|
||||
// not state.
|
||||
const routerHeldEth = heldByRouter.has(
|
||||
"0x0000000000000000000000000000000000000000",
|
||||
);
|
||||
const ethFromRouter = (v4?.settledFromRouter ?? [])
|
||||
.filter(
|
||||
(s) =>
|
||||
s.currency ===
|
||||
"0x0000000000000000000000000000000000000000",
|
||||
)
|
||||
.map((s) => ({
|
||||
currency: s.currency,
|
||||
amount:
|
||||
s.amount === CONTRACT_BALANCE ? null : s.amount,
|
||||
}));
|
||||
// What the user pays the step: what decodeV4Swap() says,
|
||||
// and the ETH of each SETTLE from the router of a known
|
||||
// amount when the router holds no other ETH.
|
||||
const paidByUser = v4
|
||||
? v4.paidByUser.concat(
|
||||
routerHeldEth
|
||||
? []
|
||||
: ethFromRouter.filter((s) =>
|
||||
present(s.amount),
|
||||
),
|
||||
)
|
||||
: [];
|
||||
if (v4) {
|
||||
// Each SETTLE paid from the router spends the amount
|
||||
// decodeV4Swap() says it pays.
|
||||
@@ -1826,6 +1969,11 @@ function decode(data, toAddress, chainId, sources, fromAddress) {
|
||||
addPayee(t.recipient, t.currency);
|
||||
}
|
||||
}
|
||||
for (const token of v4.spent) dropFromSum(token);
|
||||
for (const s of v4.paidByUser) dropFromSum(s.currency);
|
||||
for (const s of v4.settledFromRouter) {
|
||||
dropFromSum(s.currency);
|
||||
}
|
||||
}
|
||||
if (!v4 || v4.recipientUnread) {
|
||||
payeeUnread = true;
|
||||
@@ -1845,10 +1993,10 @@ function decode(data, toAddress, chainId, sources, fromAddress) {
|
||||
commandNames[i] += " (could not be decoded)";
|
||||
}
|
||||
// The step's amount, if it sets the input side: what the
|
||||
// user pays it of its input currency (see
|
||||
// decodeV4Swap()), or, when the user pays none of it,
|
||||
// what its swap actions spend of it, whoever pays that.
|
||||
const paidIn = v4?.paidByUser.find(
|
||||
// user pays it of its input currency, or, when the user
|
||||
// pays none of it, what its swap actions spend of it,
|
||||
// whoever pays that.
|
||||
const paidIn = paidByUser.find(
|
||||
(p) => p.currency === v4.tokenIn,
|
||||
);
|
||||
const amountIn = paidIn ? paidIn.amount : v4?.amountIn;
|
||||
@@ -1874,7 +2022,12 @@ function decode(data, toAddress, chainId, sources, fromAddress) {
|
||||
setInput(v4.tokenIn, amountIn);
|
||||
}
|
||||
outputToken = v4.tokenOut;
|
||||
minOutput = v4.amountOutMin;
|
||||
minOutput = swapMinimum(
|
||||
i,
|
||||
v4.tokenOut,
|
||||
v4.amountOutMin,
|
||||
takeRecipients,
|
||||
);
|
||||
outputEstablished = true;
|
||||
outputUnwrapped = false;
|
||||
unwrapIntoRouterStep = null;
|
||||
@@ -1902,10 +2055,24 @@ function decode(data, toAddress, chainId, sources, fromAddress) {
|
||||
// router still runs it.
|
||||
const setInputHere = inputEstablished && !inputSetBefore;
|
||||
if (setInputHere) inputPaidByUser = paidIn !== undefined;
|
||||
if (v4) {
|
||||
for (const p of v4.paidByUser) {
|
||||
if (setInputHere && p === paidIn) continue;
|
||||
addUserPaid(p.currency, p.amount);
|
||||
for (const p of paidByUser) {
|
||||
if (setInputHere && p === paidIn) continue;
|
||||
addUserPaid(p.currency, p.amount);
|
||||
}
|
||||
// A SETTLE of ETH from the router that `paidByUser` leaves
|
||||
// out is a take of its own, even on the step that sets
|
||||
// the input side. Either this decoder does not know its
|
||||
// amount, or ETH an earlier step left in the router may
|
||||
// pay part of that amount (see userPaid).
|
||||
for (const p of ethFromRouter) {
|
||||
if (!present(p.amount)) {
|
||||
addUserPaid(p.currency, null);
|
||||
} else if (routerHeldEth) {
|
||||
userPaid.push({
|
||||
token: p.currency,
|
||||
amount: p.amount,
|
||||
atMost: true,
|
||||
});
|
||||
}
|
||||
}
|
||||
if (!v4 || v4.settleUnread) {
|
||||
@@ -2013,10 +2180,10 @@ function decode(data, toAddress, chainId, sources, fromAddress) {
|
||||
// The total is what the steps take of Token In: the amount of the
|
||||
// step that set the input side, with each later take of that token
|
||||
// added to it while both are quantities. A take that cannot be added,
|
||||
// being of another token or coming after an amount that is not a
|
||||
// quantity (a V4 open delta, ALREADY_PAID, or none stated), gets
|
||||
// lines of its own. One whose amount is not known also leaves the
|
||||
// total unknown, with no figure.
|
||||
// being of another token, coming after an amount that is not a
|
||||
// quantity (a V4 open delta, ALREADY_PAID, or none stated), or having
|
||||
// `atMost` set, gets lines of its own. One whose amount is not known
|
||||
// also leaves the total unknown, with no figure.
|
||||
//
|
||||
// A PERMIT2_PERMIT names Token In only when its amount stands as the
|
||||
// Amount figure in place of the total, which it does only in the
|
||||
@@ -2032,12 +2199,14 @@ function decode(data, toAddress, chainId, sources, fromAddress) {
|
||||
// it may take more. A later permit or batch, or a later step this
|
||||
// decoder did not read, may raise what Permit2 lets the router take.
|
||||
// Every other PERMIT2_PERMIT leaves Token In and the Amount line as
|
||||
// they read with no permit, and gets lines of its own below. A step
|
||||
// that may take from the sender what this decoder did not read leaves
|
||||
// no figure, permit or not (see spentUnread()), and so do a permit
|
||||
// or batch whose input it cannot read (see permitUnread()) and an
|
||||
// allowance of Token In to another spender (see toAnotherSpender). An
|
||||
// EXECUTE_SUB_PLAN step leaves both sides unknown (below).
|
||||
// they read with no permit, and gets lines of its own below. A permit
|
||||
// on the zero address never stands as the Amount figure, because
|
||||
// Permit2 has no allowance of ETH. A step that may take from the
|
||||
// sender what this decoder did not read leaves no figure, permit or
|
||||
// not (see spentUnread()), and so do a permit or batch whose input it
|
||||
// cannot read (see permitUnread()) and an allowance of Token In to
|
||||
// another spender (see toAnotherSpender). An EXECUTE_SUB_PLAN step
|
||||
// leaves both sides unknown (below).
|
||||
const stepCommands = Array.from(
|
||||
commandsBytes,
|
||||
(b) => commands[b & commandTypeMask],
|
||||
@@ -2047,6 +2216,7 @@ function decode(data, toAddress, chainId, sources, fromAddress) {
|
||||
stepCommands.filter((c) => c === "PERMIT2_PERMIT").length === 1 &&
|
||||
!stepCommands.includes("PERMIT2_PERMIT_BATCH") &&
|
||||
sameAddress(permit.spender, toAddress) &&
|
||||
permit.token !== "0x0000000000000000000000000000000000000000" &&
|
||||
!permit.allowedToFail &&
|
||||
permit.beforeEveryTake &&
|
||||
!stepsUnread.some((step) => step > permit.step);
|
||||
@@ -2057,14 +2227,14 @@ function decode(data, toAddress, chainId, sources, fromAddress) {
|
||||
let total = null;
|
||||
// The takes from the sender that `total` adds up, each a quantity, as
|
||||
// { token, amount }. When there is no Amount line, each gets lines of
|
||||
// its own (see below). The amount of a step that set the input side
|
||||
// and is paid from the router counts in `total` but is not among them.
|
||||
// its own (see below). The amount of the step that set the input side
|
||||
// counts in `total` whoever pays that step. That amount is among them
|
||||
// only when the user pays the step (see inputPaidByUser).
|
||||
const inTotal = [];
|
||||
// Whether the step that set the input side counts as a take from the
|
||||
// sender, which may get lines of its own. The amount it stated counts
|
||||
// whoever pays it. Stating none, it counts only when the user pays it
|
||||
// some of its input token: paid from the router, it takes nothing
|
||||
// from the sender.
|
||||
// some of its input token.
|
||||
const hasFirstTake =
|
||||
inputEstablished && (present(inputAmount) || inputPaidByUser);
|
||||
// The take of the step that set the input side, when the total
|
||||
@@ -2090,7 +2260,8 @@ function decode(data, toAddress, chainId, sources, fromAddress) {
|
||||
if (
|
||||
ofTokenIn &&
|
||||
typeof total === "bigint" &&
|
||||
typeof t.amount === "bigint"
|
||||
typeof t.amount === "bigint" &&
|
||||
!t.atMost
|
||||
) {
|
||||
total += t.amount;
|
||||
inTotal.push(t);
|
||||
@@ -2193,8 +2364,9 @@ function decode(data, toAddress, chainId, sources, fromAddress) {
|
||||
// V2's already-paid zero, neither of which is a quantity at all (see
|
||||
// OPEN_DELTA and ALREADY_PAID), and an unbounded permit. Those two
|
||||
// tests come first — the sentinels are not bigints and cannot be
|
||||
// compared with one.
|
||||
const spentText = (amount, info) => {
|
||||
// compared with one. `atMost` marks an amount that is only the most a
|
||||
// take may be (see userPaid).
|
||||
const spentText = (amount, info, atMost) => {
|
||||
if (amount === OPEN_DELTA) {
|
||||
return { raw: OPEN_DELTA_AMOUNT, display: OPEN_DELTA_AMOUNT };
|
||||
}
|
||||
@@ -2207,7 +2379,7 @@ function decode(data, toAddress, chainId, sources, fromAddress) {
|
||||
if (amount >= MAX_UINT160) {
|
||||
return { raw: "Unlimited", display: "Unlimited" };
|
||||
}
|
||||
if (hasV2OrV3ExactOut) {
|
||||
if (hasV2OrV3ExactOut || atMost) {
|
||||
// A V2 or V3 exact-out swap spends at most this figure,
|
||||
// whichever steps gave it (an amountInMax, the WRAP_ETH of a
|
||||
// swap paid in ETH, a permit, or several steps' total), so it
|
||||
@@ -2234,17 +2406,19 @@ function decode(data, toAddress, chainId, sources, fromAddress) {
|
||||
// A null token in `spentFromSender`, a step this decoder did not read
|
||||
// or a token it does not know, and an allowance to another spender
|
||||
// that may be of Token In, leave no Amount figure, which may then be
|
||||
// too low. With no Amount line, each take the total adds up gets
|
||||
// lines of its own, first, so that every amount this decoder read is
|
||||
// shown.
|
||||
// too low. An allowance of the zero address is never one of Token In,
|
||||
// because Permit2 has no allowance of ETH. With no Amount line, each
|
||||
// take the total adds up gets lines of its own, first, so that every
|
||||
// amount this decoder read is shown.
|
||||
if (
|
||||
present(inputAmount) &&
|
||||
spentFromSender.every((s) => present(s.token)) &&
|
||||
toAnotherSpender.every(
|
||||
(p) =>
|
||||
present(p.token) &&
|
||||
present(inputToken) &&
|
||||
!sameAddress(p.token, inputToken),
|
||||
p.token === "0x0000000000000000000000000000000000000000" ||
|
||||
(present(p.token) &&
|
||||
present(inputToken) &&
|
||||
!sameAddress(p.token, inputToken)),
|
||||
)
|
||||
) {
|
||||
const amount = spentText(inputAmount, inInfo);
|
||||
@@ -2265,11 +2439,14 @@ function decode(data, toAddress, chainId, sources, fromAddress) {
|
||||
details.push({
|
||||
label: "Moved from the sender",
|
||||
value: present(s.amount)
|
||||
? spentText(s.amount, tokenInfo(s.token, sources)).display
|
||||
? spentText(s.amount, tokenInfo(s.token, sources), s.atMost)
|
||||
.display
|
||||
: UNDECODED_CURRENCY,
|
||||
});
|
||||
if (present(s.token)) {
|
||||
details.push(tokenMovedLine("Token moved", s.token, sources));
|
||||
details.push(
|
||||
tokenMovedLine("Token moved", tokenInfo(s.token, sources)),
|
||||
);
|
||||
details.push({
|
||||
label: "Moved to",
|
||||
value: "The swap step that spends it",
|
||||
@@ -2280,12 +2457,12 @@ function decode(data, toAddress, chainId, sources, fromAddress) {
|
||||
// What each PERMIT2_TRANSFER_FROM moves: its amount, its token and
|
||||
// where it goes, an address on a line of its own.
|
||||
for (const m of movedFromSender) {
|
||||
const info = permit2TokenInfo(m.token, sources);
|
||||
details.push({
|
||||
label: "Moved from the sender",
|
||||
value: amountText(m.amount, tokenInfo(m.token, sources))
|
||||
.display,
|
||||
value: amountText(m.amount, info).display,
|
||||
});
|
||||
details.push(tokenMovedLine("Token moved", m.token, sources));
|
||||
details.push(tokenMovedLine("Token moved", info));
|
||||
details.push(
|
||||
present(m.to)
|
||||
? { label: "Moved to", value: m.to }
|
||||
@@ -2315,15 +2492,15 @@ function decode(data, toAddress, chainId, sources, fromAddress) {
|
||||
});
|
||||
continue;
|
||||
}
|
||||
const info = permit2TokenInfo(p.token, sources);
|
||||
details.push({
|
||||
label: "Permit2 allowance",
|
||||
value:
|
||||
p.amount >= MAX_UINT160
|
||||
? "Unlimited"
|
||||
: amountText(p.amount, tokenInfo(p.token, sources))
|
||||
.display,
|
||||
: amountText(p.amount, info).display,
|
||||
});
|
||||
details.push(tokenMovedLine("Allowance token", p.token, sources));
|
||||
details.push(tokenMovedLine("Allowance token", info));
|
||||
details.push({
|
||||
label: "Allowance spender",
|
||||
value: p.spender,
|
||||
@@ -2381,7 +2558,7 @@ function decode(data, toAddress, chainId, sources, fromAddress) {
|
||||
paidTo.push({ label: "Paid to", value: PAID_TO_BRIDGE });
|
||||
}
|
||||
for (const m of movedIntoRouter) {
|
||||
const info = tokenInfo(m.token, sources);
|
||||
const info = permit2TokenInfo(m.token, sources);
|
||||
paidTo.push({
|
||||
label: "Paid to",
|
||||
value:
|
||||
@@ -2389,9 +2566,7 @@ function decode(data, toAddress, chainId, sources, fromAddress) {
|
||||
amountText(m.amount, info).display +
|
||||
" from the sender (later steps may not spend all of it)",
|
||||
});
|
||||
paidTo.push(
|
||||
tokenMovedLine("Token moved into the router", m.token, sources),
|
||||
);
|
||||
paidTo.push(tokenMovedLine("Token moved into the router", info));
|
||||
}
|
||||
if (outputHeld) {
|
||||
paidTo.push({ label: "Paid to", value: STAYS_IN_ROUTER });
|
||||
@@ -2408,8 +2583,7 @@ function decode(data, toAddress, chainId, sources, fromAddress) {
|
||||
paidTo.push(
|
||||
tokenMovedLine(
|
||||
"Token moved into the router",
|
||||
getAddress(token),
|
||||
sources,
|
||||
tokenInfo(getAddress(token), sources),
|
||||
),
|
||||
);
|
||||
}
|
||||
|
||||
@@ -6,6 +6,10 @@
|
||||
// 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.
|
||||
//
|
||||
// The last test covers a balance refresh by the background that is saved while
|
||||
// a switch in Settings waits for the lock
|
||||
// (https://git.eeqj.de/sneak/AutistMask/issues/653).
|
||||
|
||||
const {
|
||||
bootPopup,
|
||||
@@ -159,3 +163,50 @@ test("a refresh that returns after the background switched the network writes no
|
||||
|
||||
expectNothingStored(page);
|
||||
});
|
||||
|
||||
// The background's refresh saves Ethereum Mainnet's balances while the switch
|
||||
// in Settings waits for the lock. This page last saved a balance of "0" and no
|
||||
// token balances, the values that the switch sets.
|
||||
test("a background refresh saved while a switch in Settings waits for the lock leaves none of its balances stored", async () => {
|
||||
const profile = unversionedValidProfile();
|
||||
profile.wallets[0].addresses[0].balance = "0";
|
||||
const page = await bootPopup(profile);
|
||||
expect(page.pageErrors).toEqual([]);
|
||||
const background = require("../src/background/state");
|
||||
await page.click("btn-settings");
|
||||
|
||||
// The background takes the lock first and holds it until the test calls
|
||||
// `letGo()`. It then saves balances as backgroundRefresh() in
|
||||
// src/background/index.js does.
|
||||
let letGo;
|
||||
const refreshSave = background.updateState(async (fresh) => {
|
||||
await new Promise((resolve) => {
|
||||
letGo = resolve;
|
||||
});
|
||||
fresh.wallets[0].addresses[0].balance = "7.0";
|
||||
fresh.wallets[0].addresses[0].tokenBalances = [
|
||||
{
|
||||
address: TOKEN_ADDRESS,
|
||||
name: "Test Token",
|
||||
symbol: "TST",
|
||||
decimals: 18,
|
||||
balance: "5.0",
|
||||
holders: null,
|
||||
},
|
||||
];
|
||||
fresh.lastBalanceRefresh = Date.now();
|
||||
});
|
||||
await page.settle();
|
||||
|
||||
const select = page.node("settings-network");
|
||||
select.value = "sepolia";
|
||||
const switching = Promise.all(select.listeners.change.map((fn) => fn()));
|
||||
await page.settle();
|
||||
|
||||
letGo();
|
||||
await refreshSave;
|
||||
await switching;
|
||||
await page.settle();
|
||||
|
||||
expectNothingStored(page);
|
||||
});
|
||||
|
||||
@@ -253,6 +253,271 @@ test("a switch back in Settings after a follow whose write failed is stored", as
|
||||
expect(told.at(-1).chainId).toBe(NETWORKS.mainnet.chainId);
|
||||
});
|
||||
|
||||
// The user saves an endpoint URL in Settings on Ethereum Mainnet. Before the
|
||||
// URL is stored, the background saves a switch to Sepolia. Another write holds
|
||||
// the lock, so the popup's follow of that switch and the URL's save both wait
|
||||
// for the lock. Either may take it first. The URL is stored for neither
|
||||
// network. The flash message says that the network changed.
|
||||
test.each([
|
||||
{ button: "btn-save-rpc", field: "settings-rpc", first: "follow" },
|
||||
{ button: "btn-save-rpc", field: "settings-rpc", first: "save" },
|
||||
{
|
||||
button: "btn-save-blockscout",
|
||||
field: "settings-blockscout",
|
||||
first: "follow",
|
||||
},
|
||||
{
|
||||
button: "btn-save-blockscout",
|
||||
field: "settings-blockscout",
|
||||
first: "save",
|
||||
},
|
||||
])(
|
||||
"$button saves nothing when the network changes before the URL is stored ($first first)",
|
||||
async ({ button, field, first }) => {
|
||||
const page = await bootOnAddress();
|
||||
await page.click("btn-settings");
|
||||
// This answer passes both endpoint checks. The RPC check reads
|
||||
// Ethereum Mainnet's chain id from it. The Blockscout check reads `ok`.
|
||||
globalThis.fetch.mockResolvedValue({
|
||||
ok: true,
|
||||
json: async () => ({ result: NETWORKS.mainnet.chainId }),
|
||||
});
|
||||
const url = "https://own-node.example.invalid";
|
||||
|
||||
let releaseLock;
|
||||
const lockHeld = navigator.locks.request(
|
||||
"autistmask",
|
||||
() =>
|
||||
new Promise((resolve) => {
|
||||
releaseLock = resolve;
|
||||
}),
|
||||
);
|
||||
// The click handler runs until its save waits for the lock.
|
||||
const tapSave = async () => {
|
||||
page.node(field).value = url;
|
||||
const saving = page.node(button).listeners.click.map((fn) => fn());
|
||||
await page.settle();
|
||||
return saving;
|
||||
};
|
||||
let saving;
|
||||
if (first === "save") saving = await tapSave();
|
||||
await backgroundSwitch(page, "sepolia");
|
||||
if (first === "follow") saving = await tapSave();
|
||||
releaseLock();
|
||||
await lockHeld;
|
||||
await Promise.all(saving);
|
||||
await page.settle();
|
||||
|
||||
const { state } = require("../src/shared/state");
|
||||
expect(state.networkId).toBe("sepolia");
|
||||
expect(JSON.stringify(page.storage.read("autistmask"))).not.toContain(
|
||||
url,
|
||||
);
|
||||
expect(page.text("flash-msg")).toBe(
|
||||
"The URL was not saved because the network changed.",
|
||||
);
|
||||
},
|
||||
);
|
||||
|
||||
// The popup's follow of the background's switch to Sepolia has set `state` to
|
||||
// Sepolia. The follow's write has not returned yet, so Settings still shows
|
||||
// Ethereum Mainnet. The user taps "Save" there. The URL is for Ethereum
|
||||
// Mainnet, so the save stores the URL for neither network.
|
||||
test.each([
|
||||
{ button: "btn-save-rpc", field: "settings-rpc" },
|
||||
{ button: "btn-save-blockscout", field: "settings-blockscout" },
|
||||
])(
|
||||
"$button saves nothing when tapped while the follow's write waits",
|
||||
async ({ button, field }) => {
|
||||
const page = await bootOnAddress();
|
||||
await page.click("btn-settings");
|
||||
// This answer passes both endpoint checks on Ethereum Mainnet.
|
||||
globalThis.fetch.mockResolvedValue({
|
||||
ok: true,
|
||||
json: async () => ({ result: NETWORKS.mainnet.chainId }),
|
||||
});
|
||||
const url = "https://own-node.example.invalid";
|
||||
|
||||
const { set } = page.storage.local;
|
||||
const write = set.getMockImplementation();
|
||||
let releaseWrite;
|
||||
const writeHeld = new Promise((resolve) => {
|
||||
releaseWrite = resolve;
|
||||
});
|
||||
// The background's write lands; the next, the follow's, waits.
|
||||
set.mockImplementationOnce(write).mockImplementationOnce(
|
||||
async (items) => {
|
||||
await writeHeld;
|
||||
await write(items);
|
||||
},
|
||||
);
|
||||
await backgroundSwitch(page, "sepolia");
|
||||
const { state } = require("../src/shared/state");
|
||||
expect(state.networkId).toBe("sepolia");
|
||||
expect(page.value("settings-network")).toBe("mainnet");
|
||||
|
||||
page.node(field).value = url;
|
||||
const saving = page.node(button).listeners.click.map((fn) => fn());
|
||||
await page.settle();
|
||||
releaseWrite();
|
||||
await Promise.all(saving);
|
||||
await page.settle();
|
||||
|
||||
expect(JSON.stringify(page.storage.read("autistmask"))).not.toContain(
|
||||
url,
|
||||
);
|
||||
expect(page.text("flash-msg")).toBe(
|
||||
"The URL was not saved because the network changed.",
|
||||
);
|
||||
},
|
||||
);
|
||||
|
||||
// The user taps the RPC "Save" on Ethereum Mainnet. While the check waits for
|
||||
// the node's answer, the popup follows the background's switch to Sepolia. The
|
||||
// node answers with Sepolia's chain id. So the check refuses the node for
|
||||
// Ethereum Mainnet, and nothing is stored.
|
||||
test("the RPC check compares the answer with the network at the tap", async () => {
|
||||
const page = await bootOnAddress();
|
||||
await page.click("btn-settings");
|
||||
let answer;
|
||||
globalThis.fetch.mockReturnValue(
|
||||
new Promise((resolve) => {
|
||||
answer = resolve;
|
||||
}),
|
||||
);
|
||||
const url = "https://sepolia-node.example.invalid";
|
||||
|
||||
page.node("settings-rpc").value = url;
|
||||
const saving = page.node("btn-save-rpc").listeners.click.map((fn) => fn());
|
||||
await page.settle();
|
||||
await backgroundSwitch(page, "sepolia");
|
||||
const { state } = require("../src/shared/state");
|
||||
expect(state.networkId).toBe("sepolia");
|
||||
answer({ json: async () => ({ result: NETWORKS.sepolia.chainId }) });
|
||||
await Promise.all(saving);
|
||||
await page.settle();
|
||||
|
||||
expect(JSON.stringify(page.storage.read("autistmask"))).not.toContain(url);
|
||||
expect(page.text("flash-msg")).toBe(
|
||||
"Wrong network: expected Ethereum Mainnet.",
|
||||
);
|
||||
});
|
||||
|
||||
// The user taps the Blockscout "Save" on Ethereum Mainnet. While the check
|
||||
// waits for Blockscout's answer, the popup follows the background's switch to
|
||||
// Sepolia. The URL is for Ethereum Mainnet, so nothing is stored.
|
||||
test("the Blockscout save is for the network at the tap", async () => {
|
||||
const page = await bootOnAddress();
|
||||
await page.click("btn-settings");
|
||||
let answer;
|
||||
globalThis.fetch.mockReturnValue(
|
||||
new Promise((resolve) => {
|
||||
answer = resolve;
|
||||
}),
|
||||
);
|
||||
const url = "https://own-explorer.example.invalid/api/v2";
|
||||
|
||||
page.node("settings-blockscout").value = url;
|
||||
const saving = page
|
||||
.node("btn-save-blockscout")
|
||||
.listeners.click.map((fn) => fn());
|
||||
await page.settle();
|
||||
await backgroundSwitch(page, "sepolia");
|
||||
expect(page.value("settings-network")).toBe("sepolia");
|
||||
answer({ ok: true });
|
||||
await Promise.all(saving);
|
||||
await page.settle();
|
||||
|
||||
expect(JSON.stringify(page.storage.read("autistmask"))).not.toContain(url);
|
||||
expect(page.text("flash-msg")).toBe(
|
||||
"The URL was not saved because the network changed.",
|
||||
);
|
||||
});
|
||||
|
||||
// Settings is open when the network changes to Sepolia. The popup follows the
|
||||
// background's switch, or the user picks Sepolia in the network selector. Each
|
||||
// "Save" after the switch stores its URL for Sepolia.
|
||||
test.each([
|
||||
["a follow", (page) => backgroundSwitch(page, "sepolia")],
|
||||
[
|
||||
"the network selector",
|
||||
async (page) => {
|
||||
const select = page.node("settings-network");
|
||||
select.value = "sepolia";
|
||||
for (const fn of select.listeners.change) await fn();
|
||||
await page.settle();
|
||||
},
|
||||
],
|
||||
])(
|
||||
"after a switch to Sepolia by %s, Settings saves each URL for Sepolia",
|
||||
async (_how, switchToSepolia) => {
|
||||
const page = await bootOnAddress();
|
||||
await page.click("btn-settings");
|
||||
await switchToSepolia(page);
|
||||
// This answer passes both endpoint checks on Sepolia. The RPC check
|
||||
// reads Sepolia's chain id from it. The Blockscout check reads `ok`.
|
||||
globalThis.fetch.mockResolvedValue({
|
||||
ok: true,
|
||||
json: async () => ({ result: NETWORKS.sepolia.chainId }),
|
||||
});
|
||||
const rpcUrl = "https://own-node.example.invalid";
|
||||
const blockscoutUrl = "https://own-explorer.example.invalid/api/v2";
|
||||
|
||||
page.node("settings-rpc").value = rpcUrl;
|
||||
await page.click("btn-save-rpc");
|
||||
expect(page.text("flash-msg")).toBe("Saved.");
|
||||
page.node("settings-blockscout").value = blockscoutUrl;
|
||||
await page.click("btn-save-blockscout");
|
||||
expect(page.text("flash-msg")).toBe("Saved.");
|
||||
|
||||
const stored = page.storage.read("autistmask");
|
||||
expect(stored.networkId).toBe("sepolia");
|
||||
expect(stored.rpcUrl).toBe(rpcUrl);
|
||||
expect(stored.blockscoutUrl).toBe(blockscoutUrl);
|
||||
},
|
||||
);
|
||||
|
||||
// The user picks Sepolia in Settings, but the switch's write fails. The page is
|
||||
// then on Sepolia, while Settings was last drawn for Ethereum Mainnet. A "Save"
|
||||
// after the failed switch stores nothing for either network.
|
||||
test.each([
|
||||
{ button: "btn-save-rpc", field: "settings-rpc" },
|
||||
{ button: "btn-save-blockscout", field: "settings-blockscout" },
|
||||
])(
|
||||
"$button saves nothing after a switch in Settings whose write failed",
|
||||
async ({ button, field }) => {
|
||||
const page = await bootOnAddress();
|
||||
await page.click("btn-settings");
|
||||
page.storage.local.set.mockRejectedValueOnce(
|
||||
new Error("quota exceeded"),
|
||||
);
|
||||
const select = page.node("settings-network");
|
||||
select.value = "sepolia";
|
||||
for (const fn of select.listeners.change) {
|
||||
await expect(fn()).rejects.toThrow("quota exceeded");
|
||||
}
|
||||
await page.settle();
|
||||
const { state } = require("../src/shared/state");
|
||||
expect(state.networkId).toBe("sepolia");
|
||||
// This answer passes both endpoint checks on Ethereum Mainnet.
|
||||
globalThis.fetch.mockResolvedValue({
|
||||
ok: true,
|
||||
json: async () => ({ result: NETWORKS.mainnet.chainId }),
|
||||
});
|
||||
const url = "https://own-node.example.invalid";
|
||||
|
||||
page.node(field).value = url;
|
||||
await page.click(button);
|
||||
|
||||
expect(JSON.stringify(page.storage.read("autistmask"))).not.toContain(
|
||||
url,
|
||||
);
|
||||
expect(page.text("flash-msg")).toBe(
|
||||
"The URL was not saved because the network changed.",
|
||||
);
|
||||
},
|
||||
);
|
||||
|
||||
// Such as one a newer build wrote, which this build cannot read. Nothing reads
|
||||
// or writes the stored record for it: the popup's next save finds it, as
|
||||
// before.
|
||||
|
||||
@@ -177,6 +177,78 @@ test("a token added by contract address on Sepolia is tracked on Sepolia only",
|
||||
expect(onSepolia).not.toContain("DAI");
|
||||
});
|
||||
|
||||
// Another popup page tracks DAI on Ethereum Mainnet after this page's last
|
||||
// save. The switch's save writes only the token lists that this page changed.
|
||||
// So DAI stays in `trackedTokens`, the active network's list.
|
||||
test("a token another page tracked before a switch in Settings stays in trackedTokens", async () => {
|
||||
const boot = await bootPopup(unversionedValidProfile());
|
||||
expect(boot.pageErrors).toEqual([]);
|
||||
boot.storage.write("autistmask", {
|
||||
...boot.storage.read("autistmask"),
|
||||
trackedTokens: [MAINNET_TOKEN],
|
||||
});
|
||||
|
||||
await boot.click("btn-settings");
|
||||
await chooseNetwork(boot, "sepolia");
|
||||
|
||||
const stored = boot.storage.read("autistmask");
|
||||
expect(stored.networkId).toBe("sepolia");
|
||||
expect(stored.trackedTokens).toEqual([MAINNET_TOKEN]);
|
||||
expect(stored.networkTrackedTokens.mainnet).toEqual([]);
|
||||
});
|
||||
|
||||
// The contract lookup on SettingsAddToken answers on Ethereum Mainnet while the
|
||||
// switch to Sepolia waits for the lock. The page adds the token to Ethereum
|
||||
// Mainnet's list. The switch then keeps that list for Ethereum Mainnet.
|
||||
test("a token added while a switch in Settings waits for the lock stays tracked on Ethereum Mainnet", async () => {
|
||||
const boot = await bootOnAddToken("mainnet");
|
||||
expect(boot.pageErrors).toEqual([]);
|
||||
const { lookupTokenInfo } = require("../src/shared/balances");
|
||||
let answer;
|
||||
lookupTokenInfo.mockImplementationOnce(
|
||||
() =>
|
||||
new Promise((resolve) => {
|
||||
answer = resolve;
|
||||
}),
|
||||
);
|
||||
boot.node("settings-addtoken-address").value = NEW_TOKEN_ADDRESS;
|
||||
const adding = boot.click("btn-settings-addtoken-manual");
|
||||
await boot.click("btn-settings");
|
||||
|
||||
// Another write holds the lock, so the switch's save waits for it.
|
||||
let releaseLock;
|
||||
const lockHeld = navigator.locks.request(
|
||||
"autistmask",
|
||||
() =>
|
||||
new Promise((resolve) => {
|
||||
releaseLock = resolve;
|
||||
}),
|
||||
);
|
||||
const select = boot.node("settings-network");
|
||||
select.value = "sepolia";
|
||||
const switching = Promise.all(select.listeners.change.map((fn) => fn()));
|
||||
await boot.settle();
|
||||
|
||||
answer({ symbol: "NEW", decimals: 18, name: "New Token" });
|
||||
await boot.settle();
|
||||
releaseLock();
|
||||
await lockHeld;
|
||||
await switching;
|
||||
await adding;
|
||||
|
||||
const stored = boot.storage.read("autistmask");
|
||||
expect(stored.networkId).toBe("sepolia");
|
||||
expect(stored.trackedTokens).toEqual([]);
|
||||
expect(stored.networkTrackedTokens.mainnet).toEqual([
|
||||
{
|
||||
address: NEW_TOKEN_ADDRESS,
|
||||
symbol: "NEW",
|
||||
decimals: 18,
|
||||
name: "New Token",
|
||||
},
|
||||
]);
|
||||
});
|
||||
|
||||
describe("Back after a switch from the Settings gear", () => {
|
||||
test("SettingsAddToken no longer offers the common tokens", async () => {
|
||||
const boot = await bootOnAddToken("mainnet");
|
||||
|
||||
+693
-9
@@ -2871,8 +2871,9 @@ describe("uniswap decoder", () => {
|
||||
...USDT_400_GROUP,
|
||||
...ONE_USDT_LINES(OTHER_ADDR),
|
||||
],
|
||||
// The last swap step's minimum.
|
||||
minimum: "390.0000 USDC",
|
||||
// Both swap steps pay USDC to the user, so the minimum
|
||||
// is the sum of their two minimums.
|
||||
minimum: "980.0000 USDC",
|
||||
},
|
||||
])(
|
||||
"$kind shows each take's own lines and the allowances, and no Amount figure or Min. received",
|
||||
@@ -3310,6 +3311,683 @@ describe("uniswap decoder", () => {
|
||||
|
||||
expect(detail(result, "Amount").value).toBe("Up to 1000.0000 USDT");
|
||||
});
|
||||
|
||||
// https://git.eeqj.de/sneak/AutistMask/issues/660 — Permit2 has no
|
||||
// allowance of ETH, so a permit on the zero address reads as one on a
|
||||
// token nothing knows. On next at 53551c6 such a permit's Allowance
|
||||
// token line read ETH. A permit of 1 wei of the zero address before a
|
||||
// V4 step of 5 ETH made the Amount line read 0.000000000000000001 ETH.
|
||||
// With that permit to another spender and a SETTLE the router pays, no
|
||||
// line gave the 5 ETH.
|
||||
describe("a permit on the zero address", () => {
|
||||
const FIVE_ETH = 5000000000000000000n;
|
||||
// The lines of a permit of `amount` base units of the zero
|
||||
// address for `spender`.
|
||||
const zeroAddressLines = (amount, spender) => [
|
||||
[
|
||||
"Permit2 allowance",
|
||||
amount + " base units (decimals unknown)",
|
||||
],
|
||||
["Allowance token", ZERO_ADDR],
|
||||
["Allowance spender", getAddress(spender)],
|
||||
];
|
||||
// A V4 swap of 5 ETH for USDC. The user pays its SETTLE when
|
||||
// `payerIsUser` is true; otherwise the router pays it from the
|
||||
// transaction's value.
|
||||
const v4FiveEth = (payerIsUser) =>
|
||||
encodeV4Swap(
|
||||
new Uint8Array([
|
||||
V4_SWAP_EXACT_IN_SINGLE_ID,
|
||||
V4_SETTLE_ID,
|
||||
V4_TAKE_ALL_ID,
|
||||
]),
|
||||
[
|
||||
encodeV4ExactInSingle(
|
||||
ZERO_ADDR,
|
||||
USDC_ADDR,
|
||||
FIVE_ETH,
|
||||
1n,
|
||||
),
|
||||
settle(ZERO_ADDR, FIVE_ETH, payerIsUser),
|
||||
encodeV4TakeAll(USDC_ADDR, 1n),
|
||||
],
|
||||
);
|
||||
|
||||
test("a PERMIT2_PERMIT on the zero address names the address", () => {
|
||||
const result = decodeSteps(
|
||||
[0x00, 0x0a],
|
||||
[
|
||||
V3_600,
|
||||
encodePermit2(
|
||||
ZERO_ADDR,
|
||||
1000000000000000000n,
|
||||
ROUTER_ADDR,
|
||||
),
|
||||
],
|
||||
);
|
||||
expect(linesBetweenTokens(result)).toEqual([
|
||||
["Amount", "600.0000 USDT"],
|
||||
...zeroAddressLines("1000000000000000000", ROUTER_ADDR),
|
||||
]);
|
||||
expect(detail(result, "Allowance token").address).toBe(
|
||||
ZERO_ADDR,
|
||||
);
|
||||
});
|
||||
|
||||
test("a PERMIT2_PERMIT_BATCH entry on the zero address names the address", () => {
|
||||
const result = decodeSteps(
|
||||
[0x03, 0x00],
|
||||
[
|
||||
encodePermit2Batch(
|
||||
[
|
||||
[USDT_ADDR, USDT_600],
|
||||
[ZERO_ADDR, 1000000000000000000n],
|
||||
],
|
||||
ROUTER_ADDR,
|
||||
),
|
||||
V3_600,
|
||||
],
|
||||
);
|
||||
expect(linesBetweenTokens(result)).toEqual([
|
||||
["Amount", "600.0000 USDT"],
|
||||
...USDT_600_LINES,
|
||||
...zeroAddressLines("1000000000000000000", ROUTER_ADDR),
|
||||
]);
|
||||
});
|
||||
|
||||
test("a PERMIT2_PERMIT of 1 wei of the zero address, then a V4 step of 5 ETH the user settles, shows the 5 ETH", () => {
|
||||
const result = decodeSteps(
|
||||
[0x0a, 0x10],
|
||||
[
|
||||
encodePermit2(ZERO_ADDR, 1n, ROUTER_ADDR),
|
||||
v4FiveEth(true),
|
||||
],
|
||||
);
|
||||
expect(detail(result, "Token In").value).toBe("ETH (native)");
|
||||
expect(linesBetweenTokens(result)).toEqual([
|
||||
["Amount", "5.0000 ETH"],
|
||||
...zeroAddressLines("1", ROUTER_ADDR),
|
||||
]);
|
||||
});
|
||||
|
||||
test("a PERMIT2_PERMIT of 1 wei of the zero address to another spender, then a V4 step of 5 ETH the router settles, shows the 5 ETH", () => {
|
||||
const result = decodeSteps(
|
||||
[0x0a, 0x10],
|
||||
[
|
||||
encodePermit2(ZERO_ADDR, 1n, OTHER_ADDR),
|
||||
v4FiveEth(false),
|
||||
],
|
||||
);
|
||||
expect(detail(result, "Token In").value).toBe("ETH (native)");
|
||||
expect(linesBetweenTokens(result)).toEqual([
|
||||
["Amount", "5.0000 ETH"],
|
||||
...zeroAddressLines("1", OTHER_ADDR),
|
||||
]);
|
||||
});
|
||||
|
||||
test("a PERMIT2_PERMIT_BATCH entry of 1 wei of the zero address to another spender, then a V4 step of 5 ETH the router settles, shows the 5 ETH", () => {
|
||||
const result = decodeSteps(
|
||||
[0x03, 0x10],
|
||||
[
|
||||
encodePermit2Batch([[ZERO_ADDR, 1n]], OTHER_ADDR),
|
||||
v4FiveEth(false),
|
||||
],
|
||||
);
|
||||
expect(detail(result, "Token In").value).toBe("ETH (native)");
|
||||
expect(linesBetweenTokens(result)).toEqual([
|
||||
["Amount", "5.0000 ETH"],
|
||||
...zeroAddressLines("1", OTHER_ADDR),
|
||||
]);
|
||||
});
|
||||
});
|
||||
|
||||
// https://git.eeqj.de/sneak/AutistMask/issues/685 — Permit2 moves no
|
||||
// ETH, so a PERMIT2_TRANSFER_FROM of the zero address reads as a move
|
||||
// of a token nothing knows. On next at ec6b6b5 its lines read ETH,
|
||||
// with an ETH figure.
|
||||
describe("a PERMIT2_TRANSFER_FROM of the zero address", () => {
|
||||
const MOVED_AMOUNT =
|
||||
"1000000000000000000 base units (decimals unknown)";
|
||||
|
||||
test("to another address names the address", () => {
|
||||
const result = decodeSteps(
|
||||
[0x00, 0x02],
|
||||
[V3_600, transfer(ZERO_ADDR, OTHER_ADDR, ONE_WETH)],
|
||||
);
|
||||
expect(linesBetweenTokens(result)).toEqual([
|
||||
["Amount", "600.0000 USDT"],
|
||||
["Moved from the sender", MOVED_AMOUNT],
|
||||
["Token moved", ZERO_ADDR],
|
||||
["Moved to", OTHER_ADDR],
|
||||
]);
|
||||
expect(detail(result, "Token moved").address).toBe(ZERO_ADDR);
|
||||
});
|
||||
|
||||
test("into the router names the address", () => {
|
||||
const result = decodeSteps(
|
||||
[0x02, 0x00],
|
||||
[transfer(ZERO_ADDR, ROUTER_ADDR, ONE_WETH), V3_600],
|
||||
);
|
||||
expect(detail(result, "Paid to").value).toBe(
|
||||
"The router, " +
|
||||
MOVED_AMOUNT +
|
||||
" from the sender (later steps may not spend all of it)",
|
||||
);
|
||||
expect(detail(result, "Token moved into the router")).toEqual({
|
||||
label: "Token moved into the router",
|
||||
value: ZERO_ADDR,
|
||||
address: ZERO_ADDR,
|
||||
isToken: true,
|
||||
});
|
||||
});
|
||||
|
||||
// The V4 step's SETTLE names the user as payer and states no
|
||||
// amount. The step's lines say that the ETH amount is not known.
|
||||
test("after a V4 exact-out step of ETH, also shows that the ETH amount is not known", () => {
|
||||
const v4EthExactOut = encodeV4Swap(
|
||||
new Uint8Array([
|
||||
V4_SWAP_EXACT_OUT_SINGLE_ID,
|
||||
V4_SETTLE_ID,
|
||||
V4_TAKE_ALL_ID,
|
||||
]),
|
||||
[
|
||||
encodeV4ExactOutSingle(
|
||||
ZERO_ADDR,
|
||||
USDC_ADDR,
|
||||
590000000n,
|
||||
ONE_WETH,
|
||||
),
|
||||
encodeV4Settle(ZERO_ADDR),
|
||||
encodeV4TakeAll(USDC_ADDR, 0n),
|
||||
],
|
||||
);
|
||||
const result = decodeSteps(
|
||||
[0x10, 0x02],
|
||||
[v4EthExactOut, transfer(ZERO_ADDR, OTHER_ADDR, ONE_WETH)],
|
||||
);
|
||||
expect(detail(result, "Token In").value).toBe("ETH (native)");
|
||||
expect(linesBetweenTokens(result)).toEqual([
|
||||
["Moved from the sender", UNDECODED],
|
||||
["Token moved", "ETH"],
|
||||
["Moved to", "The swap step that spends it"],
|
||||
["Moved from the sender", MOVED_AMOUNT],
|
||||
["Token moved", ZERO_ADDR],
|
||||
["Moved to", OTHER_ADDR],
|
||||
]);
|
||||
});
|
||||
});
|
||||
|
||||
// https://git.eeqj.de/sneak/AutistMask/issues/682 — V4 pays a SETTLE
|
||||
// of ETH from the router's own ETH, whichever payer the SETTLE names,
|
||||
// and the router holds the transaction's value. On next at 36b2002 a
|
||||
// SETTLE of 1 ETH that names the router as payer gave no ETH line.
|
||||
describe("a V4 SETTLE of ETH that names the router as payer", () => {
|
||||
const ONE_ETH = 1000000000000000000n;
|
||||
// A V4 swap of `amount` of ETH for USDC. The SETTLE names the
|
||||
// router as payer.
|
||||
const v4EthFromRouter = (amount) =>
|
||||
encodeV4Swap(
|
||||
new Uint8Array([
|
||||
V4_SWAP_EXACT_IN_SINGLE_ID,
|
||||
V4_SETTLE_ID,
|
||||
V4_TAKE_ALL_ID,
|
||||
]),
|
||||
[
|
||||
encodeV4ExactInSingle(ZERO_ADDR, USDC_ADDR, amount, 1n),
|
||||
settle(ZERO_ADDR, amount, false),
|
||||
encodeV4TakeAll(USDC_ADDR, 1n),
|
||||
],
|
||||
);
|
||||
|
||||
test("after a V3 exact-in of 600 USDT, shows the 1 ETH moved from the sender", () => {
|
||||
const result = decodeSteps(
|
||||
[0x00, 0x10],
|
||||
[V3_600, v4EthFromRouter(ONE_ETH)],
|
||||
);
|
||||
expect(linesBetweenTokens(result)).toEqual([
|
||||
["Amount", "600.0000 USDT"],
|
||||
["Moved from the sender", "1.0000 ETH"],
|
||||
["Token moved", "ETH"],
|
||||
["Moved to", "The swap step that spends it"],
|
||||
]);
|
||||
});
|
||||
|
||||
// The UNWRAP_WETH leaves ETH in the router. The SETTLE may spend
|
||||
// that ETH before the transaction's value.
|
||||
test("after an UNWRAP_WETH into the router, shows at most 1 ETH moved from the sender", () => {
|
||||
const result = decodeSteps(
|
||||
[0x00, 0x0c, 0x10],
|
||||
[
|
||||
encodeV3SwapExactIn(ROUTER_ADDR, USDT_600, 1n, [
|
||||
USDT_ADDR,
|
||||
WETH_ADDR,
|
||||
]),
|
||||
encodeWrapEth(ROUTER_ADDR, 0n), // UNWRAP_WETH, same encoding
|
||||
v4EthFromRouter(ONE_ETH),
|
||||
],
|
||||
);
|
||||
expect(linesBetweenTokens(result)).toEqual([
|
||||
["Amount", "600.0000 USDT"],
|
||||
["Moved from the sender", "Up to 1.0000 ETH"],
|
||||
["Token moved", "ETH"],
|
||||
["Moved to", "The swap step that spends it"],
|
||||
]);
|
||||
});
|
||||
|
||||
test("after a WRAP_ETH of 0.5 ETH, adds the SETTLE's 0.5 ETH to the Amount line", () => {
|
||||
const result = decodeSteps(
|
||||
[0x0b, 0x10],
|
||||
[
|
||||
encodeWrapEth(ROUTER_ADDR, ONE_ETH / 2n),
|
||||
v4EthFromRouter(ONE_ETH / 2n),
|
||||
],
|
||||
);
|
||||
expect(linesBetweenTokens(result)).toEqual([
|
||||
["Amount", "1.0000 ETH"],
|
||||
]);
|
||||
});
|
||||
|
||||
// The WRAP_ETH sets Token In to ETH, and the UNWRAP_WETH leaves
|
||||
// ETH in the router. The SETTLE may spend that ETH before the
|
||||
// transaction's value, so its 1 ETH never joins the Amount line.
|
||||
test("after a WRAP_ETH and an UNWRAP_WETH into the router, keeps the Amount line and shows at most 1 ETH moved from the sender", () => {
|
||||
const result = decodeSteps(
|
||||
[0x0b, 0x0c, 0x10],
|
||||
[
|
||||
encodeWrapEth(ROUTER_ADDR, ONE_ETH / 2n),
|
||||
encodeWrapEth(ROUTER_ADDR, 0n), // UNWRAP_WETH, same encoding
|
||||
v4EthFromRouter(ONE_ETH),
|
||||
],
|
||||
);
|
||||
expect(linesBetweenTokens(result)).toEqual([
|
||||
["Amount", "0.5000 ETH"],
|
||||
["Moved from the sender", "Up to 1.0000 ETH"],
|
||||
["Token moved", "ETH"],
|
||||
["Moved to", "The swap step that spends it"],
|
||||
]);
|
||||
});
|
||||
|
||||
// A SETTLE of CONTRACT_BALANCE pays all the router holds, an
|
||||
// amount the calldata does not state.
|
||||
test("of CONTRACT_BALANCE, on the step that sets the input side, shows an unknown amount moved from the sender", () => {
|
||||
const result = decodeSteps(
|
||||
[0x10],
|
||||
[
|
||||
encodeV4Swap(
|
||||
new Uint8Array([
|
||||
V4_SWAP_EXACT_IN_SINGLE_ID,
|
||||
V4_SETTLE_ID,
|
||||
V4_TAKE_ALL_ID,
|
||||
]),
|
||||
[
|
||||
encodeV4ExactInSingle(
|
||||
ZERO_ADDR,
|
||||
USDC_ADDR,
|
||||
ONE_ETH,
|
||||
1n,
|
||||
),
|
||||
settle(ZERO_ADDR, 2n ** 255n, false), // CONTRACT_BALANCE
|
||||
encodeV4TakeAll(USDC_ADDR, 1n),
|
||||
],
|
||||
),
|
||||
],
|
||||
);
|
||||
expect(linesBetweenTokens(result)).toEqual([
|
||||
["Moved from the sender", UNDECODED],
|
||||
["Token moved", "ETH"],
|
||||
["Moved to", "The swap step that spends it"],
|
||||
]);
|
||||
});
|
||||
});
|
||||
|
||||
// https://git.eeqj.de/sneak/AutistMask/issues/647 — on next at
|
||||
// f550d8c, a split whose steps each pay WETH to the user showed only
|
||||
// the last step's minimum.
|
||||
describe("the minimum of a split that pays WETH to the user", () => {
|
||||
const WETH_01 = 100000000000000000n;
|
||||
const WETH_02 = 200000000000000000n;
|
||||
const WETH_03 = 300000000000000000n;
|
||||
// A V3 exact-in of 600 USDT for at least 0.3 WETH, and a V2
|
||||
// exact-in of 400 USDT for at least 0.2 WETH, each paid to the
|
||||
// user.
|
||||
const V3_TO_WETH = encodeV3SwapExactIn(
|
||||
USER_ADDR,
|
||||
USDT_600,
|
||||
WETH_03,
|
||||
[USDT_ADDR, WETH_ADDR],
|
||||
);
|
||||
const V2_TO_WETH = encodeV2SwapExactIn(
|
||||
USER_ADDR,
|
||||
USDT_400,
|
||||
WETH_02,
|
||||
[USDT_ADDR, WETH_ADDR],
|
||||
);
|
||||
// A V4 step that swaps 400 USDT for at least 0.2 WETH, with these
|
||||
// TAKEs of the WETH.
|
||||
const v4ToWeth = (...takes) =>
|
||||
encodeV4Swap(
|
||||
new Uint8Array([
|
||||
V4_SWAP_EXACT_IN_SINGLE_ID,
|
||||
V4_SETTLE_ID,
|
||||
...takes.map(() => V4_TAKE_ID),
|
||||
]),
|
||||
[
|
||||
encodeV4ExactInSingle(
|
||||
USDT_ADDR,
|
||||
WETH_ADDR,
|
||||
USDT_400,
|
||||
WETH_02,
|
||||
),
|
||||
encodeV4Settle(USDT_ADDR), // paid by the user
|
||||
...takes,
|
||||
],
|
||||
);
|
||||
// The swap's minimum line as [label, value], or undefined.
|
||||
const minimum = (result) =>
|
||||
result.details
|
||||
.filter(
|
||||
(d) =>
|
||||
d.label === "Min. received" ||
|
||||
d.label === "Min. paid out",
|
||||
)
|
||||
.map((d) => [d.label, d.value])[0];
|
||||
|
||||
test("a V3 and a V2 exact-in show the total of their minimums", () => {
|
||||
const result = decodeSteps(
|
||||
[0x00, 0x08],
|
||||
[V3_TO_WETH, V2_TO_WETH],
|
||||
);
|
||||
expect(minimum(result)).toEqual([
|
||||
"Min. received",
|
||||
"0.5000 WETH",
|
||||
]);
|
||||
});
|
||||
|
||||
test("a V3 exact-in and a V4 step show the total of their minimums", () => {
|
||||
const result = decodeSteps(
|
||||
[0x00, 0x10],
|
||||
[V3_TO_WETH, v4ToWeth(encodeV4Take(WETH_ADDR))],
|
||||
);
|
||||
expect(minimum(result)).toEqual([
|
||||
"Min. received",
|
||||
"0.5000 WETH",
|
||||
]);
|
||||
});
|
||||
|
||||
// The second route buys DAI for the router, then swaps all of it
|
||||
// from the router for at least 0.2 WETH.
|
||||
test("a route that hops through DAI counts its last hop's minimum", () => {
|
||||
const result = decodeSteps(
|
||||
[0x00, 0x08, 0x00],
|
||||
[
|
||||
V3_TO_WETH,
|
||||
encodeV2SwapExactIn(ROUTER_ADDR, USDT_400, DAI_400, [
|
||||
USDT_ADDR,
|
||||
DAI_ADDR,
|
||||
]),
|
||||
coder.encode(
|
||||
["address", "uint256", "uint256", "bytes", "bool"],
|
||||
[
|
||||
USER_ADDR,
|
||||
2n ** 255n, // CONTRACT_BALANCE
|
||||
WETH_02,
|
||||
encodeV3Path([DAI_ADDR, WETH_ADDR]),
|
||||
false, // paid from the router
|
||||
],
|
||||
),
|
||||
],
|
||||
);
|
||||
expect(minimum(result)).toEqual([
|
||||
"Min. received",
|
||||
"0.5000 WETH",
|
||||
]);
|
||||
});
|
||||
|
||||
// The middle step swaps 0.3 of the user's WETH for USDC, so the
|
||||
// sum of minimums starts again after it.
|
||||
test.each([
|
||||
{
|
||||
kind: "a V3 exact-in",
|
||||
command: 0x00,
|
||||
input: encodeV3SwapExactIn(USER_ADDR, WETH_03, 1n, [
|
||||
WETH_ADDR,
|
||||
USDC_ADDR,
|
||||
]),
|
||||
},
|
||||
{
|
||||
kind: "a V2 exact-in",
|
||||
command: 0x08,
|
||||
input: encodeV2SwapExactIn(USER_ADDR, WETH_03, 1n, [
|
||||
WETH_ADDR,
|
||||
USDC_ADDR,
|
||||
]),
|
||||
},
|
||||
{
|
||||
kind: "a V2 exact-out",
|
||||
command: 0x09,
|
||||
input: encodeV2SwapExactOut(USER_ADDR, 1n, WETH_03, [
|
||||
WETH_ADDR,
|
||||
USDC_ADDR,
|
||||
]),
|
||||
},
|
||||
{
|
||||
kind: "a V3 exact-out",
|
||||
command: 0x01,
|
||||
input: encodeV3SwapExactOut(USER_ADDR, 1n, WETH_03, [
|
||||
USDC_ADDR,
|
||||
WETH_ADDR,
|
||||
]),
|
||||
},
|
||||
])(
|
||||
"$kind that spends WETH between them leaves the last step's minimum",
|
||||
({ command, input }) => {
|
||||
const result = decodeSteps(
|
||||
[0x00, command, 0x08],
|
||||
[V3_TO_WETH, input, V2_TO_WETH],
|
||||
);
|
||||
expect(minimum(result)).toEqual([
|
||||
"Min. received",
|
||||
"0.2000 WETH",
|
||||
]);
|
||||
},
|
||||
);
|
||||
|
||||
// The middle step swaps 0.3 WETH and 400 DAI for USDC, both paid
|
||||
// by the user. It spends WETH whichever SETTLE comes last.
|
||||
test.each([
|
||||
{ order: "WETH first", settled: [WETH_ADDR, DAI_ADDR] },
|
||||
{ order: "DAI first", settled: [DAI_ADDR, WETH_ADDR] },
|
||||
])(
|
||||
"a V4 step that spends WETH and DAI between them leaves the last step's minimum, with the SETTLE of $order",
|
||||
({ settled }) => {
|
||||
const wethAndDaiForUsdc = encodeV4Swap(
|
||||
new Uint8Array([
|
||||
V4_SWAP_EXACT_IN_SINGLE_ID,
|
||||
V4_SWAP_EXACT_IN_SINGLE_ID,
|
||||
V4_SETTLE_ID,
|
||||
V4_SETTLE_ID,
|
||||
V4_TAKE_ALL_ID,
|
||||
]),
|
||||
[
|
||||
encodeV4ExactInSingle(
|
||||
WETH_ADDR,
|
||||
USDC_ADDR,
|
||||
WETH_03,
|
||||
1n,
|
||||
),
|
||||
encodeV4ExactInSingle(
|
||||
DAI_ADDR,
|
||||
USDC_ADDR,
|
||||
DAI_400,
|
||||
1n,
|
||||
),
|
||||
...settled.map((token) => encodeV4Settle(token)),
|
||||
encodeV4TakeAll(USDC_ADDR, 0n),
|
||||
],
|
||||
);
|
||||
const result = decodeSteps(
|
||||
[0x00, 0x10, 0x08],
|
||||
[V3_TO_WETH, wethAndDaiForUsdc, V2_TO_WETH],
|
||||
);
|
||||
expect(minimum(result)).toEqual([
|
||||
"Min. received",
|
||||
"0.2000 WETH",
|
||||
]);
|
||||
},
|
||||
);
|
||||
|
||||
// The middle step's swap actions buy WETH with the user's USDT,
|
||||
// then swap all of that WETH for USDC.
|
||||
test("a V4 step that swaps through WETH between them leaves the last step's minimum", () => {
|
||||
const usdtToUsdcThroughWeth = encodeV4Swap(
|
||||
new Uint8Array([
|
||||
V4_SWAP_EXACT_IN_SINGLE_ID,
|
||||
V4_SWAP_EXACT_IN_SINGLE_ID,
|
||||
V4_SETTLE_ID,
|
||||
V4_TAKE_ALL_ID,
|
||||
]),
|
||||
[
|
||||
encodeV4ExactInSingle(
|
||||
USDT_ADDR,
|
||||
WETH_ADDR,
|
||||
USDT_400,
|
||||
WETH_01,
|
||||
),
|
||||
encodeV4ExactInSingle(WETH_ADDR, USDC_ADDR, 0n, 1n),
|
||||
encodeV4Settle(USDT_ADDR), // paid by the user
|
||||
encodeV4TakeAll(USDC_ADDR, 0n),
|
||||
],
|
||||
);
|
||||
const result = decodeSteps(
|
||||
[0x00, 0x10, 0x08],
|
||||
[V3_TO_WETH, usdtToUsdcThroughWeth, V2_TO_WETH],
|
||||
);
|
||||
expect(minimum(result)).toEqual([
|
||||
"Min. received",
|
||||
"0.2000 WETH",
|
||||
]);
|
||||
});
|
||||
|
||||
// The middle step has no swap action. Its SETTLE or SETTLE_ALL
|
||||
// pays 0.3 WETH, and its TAKE pays that WETH to another address.
|
||||
test.each([
|
||||
{
|
||||
payment: "a SETTLE of WETH paid by the user",
|
||||
actions: [V4_SETTLE_ID, V4_TAKE_ID],
|
||||
params: [
|
||||
settle(WETH_ADDR, WETH_03, true),
|
||||
take(WETH_ADDR, OTHER_ADDR, 0n),
|
||||
],
|
||||
},
|
||||
{
|
||||
payment: "a SETTLE of WETH paid from the router",
|
||||
actions: [V4_SETTLE_ID, V4_TAKE_ID],
|
||||
params: [
|
||||
settle(WETH_ADDR, WETH_03, false),
|
||||
take(WETH_ADDR, OTHER_ADDR, 0n),
|
||||
],
|
||||
},
|
||||
{
|
||||
payment: "a SETTLE_ALL of WETH",
|
||||
actions: [V4_TAKE_ID, V4_SETTLE_ALL_ID],
|
||||
params: [
|
||||
take(WETH_ADDR, OTHER_ADDR, WETH_03),
|
||||
encodeV4SettleAll(WETH_ADDR, WETH_03),
|
||||
],
|
||||
},
|
||||
])(
|
||||
"a V4 step with $payment between them leaves the last step's minimum",
|
||||
({ actions, params }) => {
|
||||
const wethToOther = encodeV4Swap(
|
||||
new Uint8Array(actions),
|
||||
params,
|
||||
);
|
||||
const result = decodeSteps(
|
||||
[0x00, 0x10, 0x08],
|
||||
[V3_TO_WETH, wethToOther, V2_TO_WETH],
|
||||
);
|
||||
expect(minimum(result)).toEqual([
|
||||
"Min. paid out",
|
||||
"0.2000 WETH",
|
||||
]);
|
||||
},
|
||||
);
|
||||
|
||||
test("a PERMIT2_TRANSFER_FROM of WETH between them leaves the last step's minimum", () => {
|
||||
const result = decodeSteps(
|
||||
[0x00, 0x02, 0x08],
|
||||
[
|
||||
V3_TO_WETH,
|
||||
permit2TransferFrom(WETH_ADDR, OTHER_ADDR, WETH_03),
|
||||
V2_TO_WETH,
|
||||
],
|
||||
);
|
||||
expect(minimum(result)).toEqual([
|
||||
"Min. paid out",
|
||||
"0.2000 WETH",
|
||||
]);
|
||||
});
|
||||
|
||||
// The decoder reads no minimum from a V4 exact-out action.
|
||||
test("a step that states no minimum leaves no figure", () => {
|
||||
const exactOut = encodeV4Swap(
|
||||
new Uint8Array([
|
||||
V4_SWAP_EXACT_OUT_SINGLE_ID,
|
||||
V4_SETTLE_ALL_ID,
|
||||
V4_TAKE_ALL_ID,
|
||||
]),
|
||||
[
|
||||
encodeV4ExactOutSingle(
|
||||
USDT_ADDR,
|
||||
WETH_ADDR,
|
||||
WETH_02,
|
||||
USDT_400,
|
||||
),
|
||||
encodeV4SettleAll(USDT_ADDR, USDT_400),
|
||||
encodeV4TakeAll(WETH_ADDR, 0n),
|
||||
],
|
||||
);
|
||||
const result = decodeSteps(
|
||||
[0x10, 0x00],
|
||||
[exactOut, V3_TO_WETH],
|
||||
);
|
||||
expect(minimum(result)).toBeUndefined();
|
||||
});
|
||||
|
||||
test("a step that pays some of its WETH to the router leaves no figure", () => {
|
||||
const result = decodeSteps(
|
||||
[0x00, 0x10],
|
||||
[
|
||||
V3_TO_WETH,
|
||||
v4ToWeth(
|
||||
take(WETH_ADDR, USER_ADDR, WETH_01),
|
||||
take(WETH_ADDR, ROUTER_ADDR, 0n),
|
||||
),
|
||||
],
|
||||
);
|
||||
expect(minimum(result)).toBeUndefined();
|
||||
});
|
||||
|
||||
// The router still runs a swap step whose recipient cannot be
|
||||
// read, and that step may spend the WETH the first step paid.
|
||||
test("a step between them that cannot be read leaves no figure", () => {
|
||||
const result = decodeSteps(
|
||||
[0x00, 0x00, 0x08],
|
||||
[
|
||||
V3_TO_WETH,
|
||||
dirtyWord(
|
||||
encodeV3SwapExactIn(USER_ADDR, WETH_03, 1n, [
|
||||
WETH_ADDR,
|
||||
USDC_ADDR,
|
||||
]),
|
||||
0,
|
||||
),
|
||||
V2_TO_WETH,
|
||||
],
|
||||
);
|
||||
expect(minimum(result)).toBeUndefined();
|
||||
});
|
||||
});
|
||||
});
|
||||
|
||||
// https://git.eeqj.de/sneak/AutistMask/issues/359 — the output half, in
|
||||
@@ -4052,10 +4730,9 @@ describe("uniswap decoder", () => {
|
||||
expect(detail(result, "Min. received").value).toBe("2.0000 USDC");
|
||||
});
|
||||
|
||||
// With no minimum stated before it, a zero balance check is what sets the
|
||||
// output side, and it guarantees nothing. No step pays anyone, so the
|
||||
// minimum is not said to be received.
|
||||
test("a zero balance check with no earlier minimum states no minimum", () => {
|
||||
// A zero balance check sets neither Token Out nor the minimum. The route
|
||||
// pays only the WRAP_ETH's WETH, to the router, where it stays.
|
||||
test("a zero balance check after a WRAP_ETH into the router names no output token and no minimum", () => {
|
||||
const data = buildExecute(
|
||||
solidityPacked(["uint8", "uint8"], [0x0b, 0x0e]),
|
||||
[
|
||||
@@ -4068,9 +4745,16 @@ describe("uniswap decoder", () => {
|
||||
const result = uniswap.decode(data, ROUTER_ADDR, "0x1", {}, USER_ADDR);
|
||||
expect(result).not.toBeNull();
|
||||
|
||||
expect(detail(result, "Token Out").value).toContain("USDT");
|
||||
expect(detail(result, "Min. paid out").value).toBe(
|
||||
"None (no minimum guaranteed)",
|
||||
expect(detail(result, "Token Out").value).toBe(
|
||||
"Unknown (not named in the calldata)",
|
||||
);
|
||||
expect(detail(result, "Min. paid out")).toBeUndefined();
|
||||
expect(detail(result, "Min. received")).toBeUndefined();
|
||||
expect(detail(result, "Paid to").value).toBe(
|
||||
"The router, where it stays (no later step pays it out)",
|
||||
);
|
||||
expect(detail(result, "Token moved into the router").address).toBe(
|
||||
WETH_ADDR,
|
||||
);
|
||||
});
|
||||
|
||||
|
||||
@@ -688,6 +688,62 @@ describe("an UNWRAP_WETH makes the output ETH only when the router holds it", ()
|
||||
]);
|
||||
});
|
||||
|
||||
// The same route, then a balance check of the sender's USDC with a zero
|
||||
// minimum. The check guarantees nothing, so Token Out stays ETH
|
||||
// (https://git.eeqj.de/sneak/AutistMask/issues/649).
|
||||
test("the same route, then a zero balance check of USDC, still reads as ETH with no minimum", () => {
|
||||
const result = decode(
|
||||
execute(
|
||||
v4Swap(
|
||||
SWAP_USDT_FOR_WETH,
|
||||
SETTLE_USDT,
|
||||
take(WETH, MSG_SENDER, (ONE_WETH * 6n) / 10n),
|
||||
take(WETH, ADDRESS_THIS),
|
||||
),
|
||||
unwrapWeth(MSG_SENDER),
|
||||
balanceCheck(USDC, 0n),
|
||||
),
|
||||
);
|
||||
expect(result.name).toBe("Swap USDT → ETH");
|
||||
expect(detail(result, "Token Out").value).toBe("ETH");
|
||||
expect(labels(result)).toEqual([
|
||||
"Protocol",
|
||||
"Token In",
|
||||
"Amount",
|
||||
"Token Out",
|
||||
"Steps",
|
||||
"Deadline",
|
||||
]);
|
||||
});
|
||||
|
||||
// A PERMIT2_TRANSFER_FROM moves the sender's WETH into the router. An
|
||||
// UNWRAP_WETH pays that WETH to the user as ETH. A zero balance check of
|
||||
// USDC sets neither Token Out nor the minimum, before the UNWRAP_WETH or
|
||||
// after it (https://git.eeqj.de/sneak/AutistMask/issues/649).
|
||||
test.each([
|
||||
{
|
||||
kind: "before the UNWRAP_WETH",
|
||||
steps: [balanceCheck(USDC, 0n), unwrapWeth(MSG_SENDER)],
|
||||
},
|
||||
{
|
||||
kind: "after the UNWRAP_WETH",
|
||||
steps: [unwrapWeth(MSG_SENDER), balanceCheck(USDC, 0n)],
|
||||
},
|
||||
])(
|
||||
"WETH moved into the router and unwrapped, with a zero balance check of USDC $kind, reads as ETH with no minimum",
|
||||
({ steps }) => {
|
||||
const result = decode(
|
||||
execute(
|
||||
permit2TransferFrom(WETH, ADDRESS_THIS, ONE_WETH),
|
||||
...steps,
|
||||
),
|
||||
);
|
||||
expect(detail(result, "Token Out").value).toBe("ETH");
|
||||
expect(detail(result, "Min. received")).toBeUndefined();
|
||||
expect(detail(result, "Min. paid out")).toBeUndefined();
|
||||
},
|
||||
);
|
||||
|
||||
// A TAKE the decoder cannot read may pay part of the WETH to the user.
|
||||
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(
|
||||
@@ -1661,9 +1717,18 @@ describe("any token left in the router is not received", () => {
|
||||
),
|
||||
min: "1990.0000 USDC",
|
||||
},
|
||||
{
|
||||
kind: "a swap paying WETH to the router, an UNWRAP_WETH into the router, then a V4 swap settling all the ETH from the router",
|
||||
data: execute(
|
||||
])("$kind reads as a swap paid to the user", ({ data, min }) => {
|
||||
const result = decode(data);
|
||||
expect(labels(result)).toEqual(PAID_TO_USER);
|
||||
expect(detail(result, "Min. received").value).toBe(min);
|
||||
});
|
||||
|
||||
// https://git.eeqj.de/sneak/AutistMask/issues/682 — the SETTLE spends all
|
||||
// the router's ETH, the transaction's value included, so the sender pays
|
||||
// an amount the calldata does not state.
|
||||
test("a swap paying WETH to the router, an UNWRAP_WETH into the router, then a V4 swap settling all the ETH from the router reads as a swap paid to the user", () => {
|
||||
const result = decode(
|
||||
execute(
|
||||
swapToWeth(ADDRESS_THIS),
|
||||
unwrapWeth(ADDRESS_THIS),
|
||||
v4Swap(
|
||||
@@ -1672,12 +1737,23 @@ describe("any token left in the router is not received", () => {
|
||||
takeAll(USDC),
|
||||
),
|
||||
),
|
||||
min: "1990.0000 USDC",
|
||||
},
|
||||
])("$kind reads as a swap paid to the user", ({ data, min }) => {
|
||||
const result = decode(data);
|
||||
expect(labels(result)).toEqual(PAID_TO_USER);
|
||||
expect(detail(result, "Min. received").value).toBe(min);
|
||||
);
|
||||
expect(labels(result)).toEqual([
|
||||
"Protocol",
|
||||
"Token In",
|
||||
"Amount",
|
||||
"Moved from the sender",
|
||||
"Token moved",
|
||||
"Moved to",
|
||||
"Token Out",
|
||||
"Min. received",
|
||||
"Steps",
|
||||
"Deadline",
|
||||
]);
|
||||
expect(detail(result, "Moved from the sender").value).toBe(
|
||||
"Unknown (could not be decoded)",
|
||||
);
|
||||
expect(detail(result, "Min. received").value).toBe("1990.0000 USDC");
|
||||
});
|
||||
});
|
||||
|
||||
@@ -2800,17 +2876,16 @@ describe("the allow-revert flag", () => {
|
||||
},
|
||||
);
|
||||
|
||||
test("a BALANCE_CHECK_ERC20 with the flag, and no minimum before it, states none", () => {
|
||||
test("a BALANCE_CHECK_ERC20 with the flag, and no minimum before it, names no output token and no minimum", () => {
|
||||
const check = balanceCheck(WETH, ONE_WETH);
|
||||
expect(detail(decode(execute(check)), "Min. paid out").value).toBe(
|
||||
"1.0000 WETH",
|
||||
);
|
||||
|
||||
const withFlag = decode(execute(flagged(check)));
|
||||
expect(detail(withFlag, "Token Out").address).toBe(WETH);
|
||||
expect(detail(withFlag, "Min. paid out").value).toBe(
|
||||
"None (no minimum guaranteed)",
|
||||
);
|
||||
expect(detail(withFlag, "Token Out").value).toBe(UNNAMED);
|
||||
expect(detail(withFlag, "Min. paid out")).toBeUndefined();
|
||||
expect(detail(withFlag, "Min. received")).toBeUndefined();
|
||||
});
|
||||
|
||||
// Only the routers from UniversalRouterV2 on let a PERMIT2_PERMIT fail.
|
||||
|
||||
Reference in New Issue
Block a user