Author SHA1 Message Date
sneak e94960c627 fix: the address screen shows a token just added at its fetched balance, not 0.0000 (closes #516)
check / check (push) Canceled after 0s
e2e / e2e-chrome (push) Canceled after 0s
e2e / e2e-firefox (push) Canceled after 0s
A balance refresh that returns now draws the balances on AddressDetail or
AddressToken again when that screen is up, not only the wallet list. Their
transaction lists are left alone.

Every add path on AddToken and SettingsAddToken tracks a token through
trackToken(), which gives the tracked record `balanceNotFetched: true`. While
the field is set, the token's line reads `quantity unknown` instead of 0.0000.
refreshBalances() now resolves with the tracked tokens whose balance it read
at every address. The popup's refresh deletes the field from those tokens in
the stored record and leaves the rest of the stored list as it is. Removing
the token removes the field, and each network keeps its own records.

Model: opus-5-5
2026-10-27 00:35:56 +00:00
20 changed files with 788 additions and 378 deletions
+114 -107
View File
@@ -1493,7 +1493,9 @@ send-screen token selector, the address total and the remove-address warning
(`isBelowOneMillionth()` in `src/shared/amountDisplay.js`). The Send and (`isBelowOneMillionth()` in `src/shared/amountDisplay.js`). The Send and
confirmation screens show it when its token is the one being sent. Tracked confirmation screens show it when its token is the one being sent. Tracked
tokens with a zero balance are listed as well while "Show tracked tokens with tokens with a zero balance are listed as well while "Show tracked tokens with
zero balance" is on. zero balance" is on. While that setting is on, a token just added reads
`quantity unknown` at an address with no entry for it, until a refresh has read
its balance at every address (see AddToken).
#### Stored state and its version #### Stored state and its version
@@ -1677,6 +1679,13 @@ network switch (below). That popup then redraws its top screen as a reopened
popup would. A screen that a reopened popup cannot render, such as Send, is popup would. A screen that a reopened popup cannot render, such as Send, is
replaced by Home. replaced by Home.
The popup refreshes balances every ten seconds while it is open
(`doRefreshAndRender()` in `src/popup/index.js`). Each refresh that returns
draws the wallet list again. When AddressDetail or AddressToken is up, the
refresh also draws that screen's USD total and balance lines again, but not its
transaction list. A refresh draws no other screen again, DeleteAddress and its
balance lines included.
A network switch leaves every screen on the page showing the previous network. A network switch leaves every screen on the page showing the previous network.
The user makes it in Settings, or approves a site's request and the background The user makes it in Settings, or approves a site's request and the background
saves it. Any other popup open meanwhile takes the switch from the stored saves it. Any other popup open meanwhile takes the switch from the stored
@@ -2233,7 +2242,15 @@ view would leave a wallet one click from deletion.
- "Add" button - "Add" button
- **Transitions**: - **Transitions**:
- "Add" (valid contract) → tracks the token, pops the stack, and re-renders - "Add" (valid contract) → tracks the token, pops the stack, and re-renders
**AddressDetail** **AddressDetail**. Until a balance refresh on the token's network has read
the token's balance at every address, its line never reads `0.0000`. The
line reads `quantity unknown` instead, or is left out while "Show tracked
tokens with zero balance" is off. Where Blockscout already listed a
holding of the token, the line shows that holding. Until that refresh, the
tracked token's record carries `balanceNotFetched`, so the line still
reads `quantity unknown` after the popup closes and opens again. A refresh
that returns draws AddressDetail's balances again (see Navigation), so the
fetched balance shows without the screen being reopened
- "Add" with a token already tracked, a scam-listed address, or a failed - "Add" with a token already tracked, a scam-listed address, or a failed
contract lookup → flash message, no screen change contract lookup → flash message, no screen change
- "Add", then a network switch in Settings before the contract lookup - "Add", then a network switch in Settings before the contract lookup
@@ -2534,7 +2551,9 @@ view would leave a wallet one click from deletion.
add path add path
- **Transitions**: - **Transitions**:
- Any of the add paths shown, on success → adds the token and shows an - Any of the add paths shown, on success → adds the token and shows an
"Added SYMBOL" flash message (no screen change) "Added SYMBOL" flash message (no screen change). Until a refresh has read
the token's balance at every address, its lines read as after "Add" on
AddToken
- A duplicate, a scam-listed address, or a failed contract lookup → flash - A duplicate, a scam-listed address, or a failed contract lookup → flash
message, no screen change message, no screen change
- "Add" by contract address, then a network switch in Settings before the - "Add" by contract address, then a network switch in Settings before the
@@ -3412,47 +3431,43 @@ Currently supported:
as a swap paid in ETH does, but only when that amount is not as a swap paid in ETH does, but only when that amount is not
`CONTRACT_BALANCE` and the router held no WETH from an earlier step when the `CONTRACT_BALANCE` and the router held no WETH from an earlier step when the
`WRAP_ETH` ran: after two `WRAP_ETH`s of 0.5 ETH into the router, a swap of 1 `WRAP_ETH` ran: after two `WRAP_ETH`s of 0.5 ETH into the router, a swap of 1
WETH from it reads as leaving the WETH there. An `UNWRAP_WETH` into the router WETH from it reads as leaving the WETH there. A V2 or V3 exact-out step paid
turns all the router's WETH into as much ETH. The decoder then knows how much from the router spends an amount the calldata does not state, at most its
ETH the router holds only when it knew the WETH's amount and the router held `amountInMax`, so the decoder counts it as spending nothing the router holds.
no ETH before. A V4 `SETTLE` of ETH spends the ETH the router holds, whoever A `SETTLE` of `OPEN_DELTA` (zero), and a `SETTLE_ALL`, pay only what the step
pays it (see below). A V2 or V3 exact-out step paid from the router spends an still owes of their token when they run. The decoder takes that to be the
amount the calldata does not state, at most its `amountInMax`, so the decoder amounts the step's swap actions state they spend of that token only when every
counts it as spending nothing the router holds. A `SETTLE` of `OPEN_DELTA` action in the step could be read, every swap action names the token it spends
(zero), and a `SETTLE_ALL`, pay only what the step still owes of their token and the token it buys (a swap action with an empty path swaps nothing), the
when they run. The decoder takes that to be the amounts the step's swap `SETTLE` or `SETTLE_ALL` is the step's only `SETTLE` or `SETTLE_ALL` of that
actions state they spend of that token only when every action in the step token and comes after every swap action, no swap action buys that token, no
could be read, every swap action names the token it spends and the token it `TAKE`, `TAKE_ALL` or `TAKE_PORTION` in the step takes it (a `TAKE` of a
buys (a swap action with an empty path swaps nothing), the `SETTLE` or stated amount adds to what the step owes), and the swap actions that spend it
`SETTLE_ALL` is the step's only `SETTLE` or `SETTLE_ALL` of that token and state a quantity together; otherwise it does not know the amount, and such a
comes after every swap action, no swap action buys that token, no `TAKE`, `SETTLE` from the router counts as spending nothing. So the rest of a V4
`TAKE_ALL` or `TAKE_PORTION` in the step takes it (a `TAKE` of a stated amount `SETTLE` of more than its swap spends, taken to the router, the WETH of a
adds to what the step owes), and the swap actions that spend it state a `WRAP_ETH`, and a token a swap pays the router on the way to the output, each
quantity together; otherwise it does not know the amount, and such a `SETTLE` stays in the router when later steps do not spend all of it, where anyone can
from the router counts as spending nothing. So the rest of a V4 `SETTLE` of take it in a later transaction. The router sends ETH as written, so a
more than its swap spends, taken to the router, the WETH of a `WRAP_ETH`, and `TRANSFER` of `CONTRACT_BALANCE` of ETH always reverts and pays out nothing. A
a token a swap pays the router on the way to the output, each stays in the step paying a token to the V2 pair that the very next step spends, as a V2
router when later steps do not spend all of it, where anyone can take it in a exact-in of that token whose `amountIn` is `ALREADY_PAID` (zero) or
later transaction. The router sends ETH as written, so a `TRANSFER` of `CONTRACT_BALANCE`, is a hop, not a payout: Uniswap's mixed routes pay the
`CONTRACT_BALANCE` of ETH always reverts and pays out nothing. A step paying a next V2 pair directly, and the router enforces that swap's own minimum. The
token to the V2 pair that the very next step spends, as a V2 exact-in of that decoder checks that the address paid is that pair, deriving it from the V2
token whose `amountIn` is `ALREADY_PAID` (zero) or `CONTRACT_BALANCE`, is a factory and pair init code hash the network's routers were deployed with and
hop, not a payout: Uniswap's mixed routes pay the next V2 pair directly, and the first two tokens of that step's path; a payment to any other address is
the router enforces that swap's own minimum. The decoder checks that the named. (Sepolia's `UniversalRouterV1_2_V2Support` was deployed with
address paid is that pair, deriving it from the V2 factory and pair init code placeholders for both values, so no V2 swap step can succeed on that router.)
hash the network's routers were deployed with and the first two tokens of that Every other payment counts, in whichever step and of whatever token, a share
step's path; a payment to any other address is named. (Sepolia's of the output included: an interface fee paid to another address by
`UniversalRouterV1_2_V2Support` was deployed with placeholders for both `PAY_PORTION`, `TRANSFER` or `TAKE_PORTION` is named, and the minimum reads
values, so no V2 swap step can succeed on that router.) Every other payment `Min. paid out`, because the swap's minimum includes the fee. The minimum
counts, in whichever step and of whatever token, a share of the output reads `Min. received` only when some step pays the transaction's sender (the
included: an interface fee paid to another address by `PAY_PORTION`, From address on TxApproval, the sender the explorer reports on
`TRANSFER` or `TAKE_PORTION` is named, and the minimum reads `Min. paid out`, TransactionDetail), no `Paid to` line is shown, and no permit or batch grants
because the swap's minimum includes the fee. The minimum reads `Min. received` an allowance to a spender other than the router (see below). `Paid to` lines
only when some step pays the transaction's sender (the From address on after `Token Out` name each other address paid; one reads
TxApproval, the sender the explorer reports on TransactionDetail), no
`Paid to` line is shown, and no permit or batch grants an allowance to a
spender other than the router (see below). `Paid to` lines after `Token Out`
name each other address paid; one reads
`The bridge, which pays the deposit's recipient on another network` for a `The bridge, which pays the deposit's recipient on another network` for a
bridge deposit; one reads, for example, bridge deposit; one reads, for example,
`The router, 2000.0000 USDT from the sender (later steps may not spend all of it)` `The router, 2000.0000 USDT from the sender (later steps may not spend all of it)`
@@ -3481,62 +3496,56 @@ Currently supported:
of any amount but `OPEN_DELTA` pays that amount, and a `SETTLE` of 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 `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 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`. V4 pays ETH from the rest taken to another address, reads `5000.0000 USDT`. A later step paid from
router's own ETH, whoever a `SETTLE` names as payer. So when a V4 step would the router spends what the router holds and takes nothing, and so does a V2
take ETH from the user's wallet, ETH the router already holds pays first. The exact-in whose `amountIn` is `ALREADY_PAID`. A later take of `Token In` is
wallet pays only the rest. For example, an `UNWRAP_WETH` into the router added to the total while both are quantities: a V3 exact-in of 600 USDT and a
leaves ETH there. When the decoder does not know how much ETH the router V2 exact-in of 400 USDT, both paid by the user, read `1000.0000 USDT`. When
holds, or how much the step would take, it counts the router as paying all of the decoder does not know a take's amount, the total is not known and there is
that ETH. A later step paid from the router spends what the router holds and no `Amount` line. A `PERMIT2_PERMIT` names `Token In` only when its amount,
takes nothing, and so does a V2 exact-in whose `amountIn` is `ALREADY_PAID`. A `Unlimited` included, stands as the `Amount` figure in place of the total,
later take of `Token In` is added to the total while both are quantities: a V3 which it does only in the plain shape of Uniswap's own routes: it comes before
exact-in of 600 USDT and a V2 exact-in of 400 USDT, both paid by the user, the step that sets the input side, it is the only `PERMIT2_PERMIT` in the
read `1000.0000 USDT`. When the decoder does not know a take's amount, the transaction and there is no `PERMIT2_PERMIT_BATCH`, its spender is the router,
total is not known and there is no `Amount` line. A `PERMIT2_PERMIT` names the router may not let it fail, no step before it takes its token, a
`Token In` only when its amount, `Unlimited` included, stands as the `Amount` `PERMIT2_TRANSFER_FROM` of it included, or a token the decoder does not know,
figure in place of the total, which it does only in the plain shape of and the decoder reads every step after it in full. Permit2 then lets the
Uniswap's own routes: it comes before the step that sets the input side, it is router take no more of the token than that amount, so the permit covers every
the only `PERMIT2_PERMIT` in the transaction and there is no take of it. A step before the permit takes under whatever allowance the router
`PERMIT2_PERMIT_BATCH`, its spender is the router, the router may not let it already had, so it may take more than the permit's amount, which would then
fail, no step before it takes its token, a `PERMIT2_TRANSFER_FROM` of it read lower than what leaves the user's wallet: a `PERMIT2_TRANSFER_FROM` of
included, or a token the decoder does not know, and the decoder reads every 2,000 USDT into the router, then a permit of 600 USDT to the router and a V3
step after it in full. Permit2 then lets the router take no more of the token exact-in of 2,000 USDT paid from the router, read `Amount 2000.0000 USDT`. A
than that amount, so the permit covers every take of it. A step before the later permit or batch may raise what Permit2 lets the router take, and so may
permit takes under whatever allowance the router already had, so it may take a step the decoder does not read in full: a command the decoder does not read
more than the permit's amount, which would then read lower than what leaves (listed at the end of this section), a step whose input it cannot read, in
the user's wallet: a `PERMIT2_TRANSFER_FROM` of 2,000 USDT into the router, whole or in part, and a step it fails on. Every other `PERMIT2_PERMIT`, before
then a permit of 600 USDT to the router and a V3 exact-in of 2,000 USDT paid the step that sets the input side or after it, leaves `Token In` and the
from the router, read `Amount 2000.0000 USDT`. A later permit or batch may `Amount` line as they read with no permit, unless it lets a spender other than
raise what Permit2 lets the router take, and so may a step the decoder does the router take `Token In` (see below): a permit of 5,000 DAI to another
not read in full: a command the decoder does not read (listed at the end of address and then a V3 exact-in of 600 USDT read `Swap USDT → USDC` with
this section), a step whose input it cannot read, in whole or in part, and a `Amount 600.0000 USDT`, and so do that exact-in and then a permit of 5,000 DAI
step it fails on. Every other `PERMIT2_PERMIT`, before the step that sets the to the router. When a permit's amount stands and the step that sets the input
input side or after it, leaves `Token In` and the `Amount` line as they read side spends a token other than the permit's, or one the decoder does not know,
with no permit, unless it lets a spender other than the router take `Token In` that step's amount gets lines of its own, unless it states no amount and the
(see below): a permit of 5,000 DAI to another address and then a V3 exact-in user pays it none of its input token. Each take the total does not count gives
of 600 USDT read `Swap USDT → USDC` with `Amount 600.0000 USDT`, and so do three lines after the `Amount` line (after `Token In` when there is none): one
that exact-in and then a permit of 5,000 DAI to the router. When a permit's of a token other than `Token In`; one of `Token In` after an amount that is
amount stands and the step that sets the input side spends a token other than not a quantity (a V4 open delta, `ALREADY_PAID`, which keep their wording on
the permit's, or one the decoder does not know, that step's amount gets lines the `Amount` line, or no stated amount, as of a V4 exact-out step); and one
of its own, unless it states no amount and the user pays it none of its input whose amount the decoder does not know. When there is no `Amount` line, each
token. Each take the total does not count gives three lines after the `Amount` take the total counts gets them too, so that every amount the decoder reads is
line (after `Token In` when there is none): one of a token other than shown: the amount the step that sets the input side states, when it is a
`Token In`; one of `Token In` after an amount that is not a quantity (a V4 quantity and the user pays that step (a V2 or V3 step whose `payerIsUser` is
open delta, `ALREADY_PAID`, which keep their wording on the `Amount` line, or true, a V4 step the user pays some of its input token, or a `WRAP_ETH`, whose
no stated amount, as of a V4 exact-out step); and one whose amount the decoder ETH comes from the transaction's value), and each later take of `Token In`
does not know. When there is no `Amount` line, each take the total counts gets added to it. A step that sets the input side and is paid from the router takes
them too, so that every amount the decoder reads is shown: the amount the step nothing from the user's wallet and gets none. A `PERMIT2_PERMIT` the decoder
that sets the input side states, when it is a quantity and the user pays that cannot read, then V3 exact-ins of 600 USDT and 400 DAI paid by the user, give
step (a V2 or V3 step whose `payerIsUser` is true, a V4 step the user pays lines for both amounts. When the step that sets the input side states no
some of its input token, or a `WRAP_ETH`, whose ETH comes from the amount, the user pays it some of its input token, and there is no `Amount`
transaction's value), and each later take of `Token In` added to it. A step line, that step gets them too whenever another take's lines give a figure, or
that sets the input side and is paid from the router takes nothing from the a `PERMIT2_TRANSFER_FROM` of its token gives one, on the lines below or, into
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 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, 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 as when the router pays it, that step takes none of that token from the user's
@@ -3546,13 +3555,11 @@ Currently supported:
`Moved from the sender`, its amount, worded as the `Amount` line words one, or `Moved from the sender`, its amount, worded as the `Amount` line words one, or
`Unknown (could not be decoded)` when the decoder does not know it; `Unknown (could not be decoded)` when the decoder does not know it;
`Token moved`, giving the token's address as the `Token In` line does; and `Token moved`, giving the token's address as the `Token In` line does; and
`Moved to`, which reads `The swap step that spends it`. For a `WRAP_ETH` that `Moved to`, which reads `The swap step that spends it`. A token the decoder
pays its WETH to anyone but the router, `Moved to` names that recipient does not know gives the `Moved from the sender` line alone. A step may also
instead: `The sender` for `address(1)`, and otherwise the address. A token the take from the user's wallet what the decoder did not read: a V4 step whose
decoder does not know gives the `Moved from the sender` line alone. A step may input or one of whose `SETTLE`s or `SETTLE_ALL`s it cannot read, which the
also take from the user's wallet what the decoder did not read: a V4 step router still runs; a V2 or V3 exact-in or exact-out step or a
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 `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 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; `PERMIT2_TRANSFER_FROM_BATCH`; every `EXECUTE_SUB_PLAN`, wherever it stands;
+16 -1
View File
@@ -6,6 +6,7 @@ const {
saveState, saveState,
onSaveFailure, onSaveFailure,
takeStoredNetwork, takeStoredNetwork,
clearBalanceNotFetched,
loadState, loadState,
} = require("../shared/state"); } = require("../shared/state");
const { StateUnusableError } = require("../shared/stateSchema"); const { StateUnusableError } = require("../shared/stateSchema");
@@ -88,6 +89,17 @@ let refreshTimer = null;
// removed meanwhile is left as it is. Blockscout may have answered before the // removed meanwhile is left as it is. Blockscout may have answered before the
// user turned "Use Blockscout" off. So the save drops every token the user has // user turned "Use Blockscout" off. So the save drops every token the user has
// not tracked if the stored setting is off by then. // not tracked if the stored setting is off by then.
//
// The save also deletes `balanceNotFetched` from each tracked token whose
// balance this refresh read at every address. trackToken() in
// src/popup/views/helpers.js sets that field. The save takes the field off the
// matching tokens of the stored record (clearBalanceNotFetched() in
// src/shared/state.js). The rest of the stored tracked token list stays as it
// is.
//
// Once the save is done, the wallet list is drawn again. So are the balances
// on AddressDetail or AddressToken when that screen is up. No other screen is
// drawn again, DeleteAddress and its balance lines included.
async function doRefreshAndRender() { async function doRefreshAndRender() {
if (refreshInFlight) return; if (refreshInFlight) return;
refreshInFlight = true; refreshInFlight = true;
@@ -95,7 +107,7 @@ async function doRefreshAndRender() {
await followStoredSettings(); await followStoredSettings();
const networkId = state.networkId; const networkId = state.networkId;
const wallets = structuredClone(state.wallets); const wallets = structuredClone(state.wallets);
await Promise.all([ const [, readTokens] = await Promise.all([
refreshPrices(), refreshPrices(),
refreshBalances( refreshBalances(
wallets, wallets,
@@ -127,10 +139,13 @@ async function doRefreshAndRender() {
if (!stored.useBlockscout) { if (!stored.useBlockscout) {
dropUntrackedTokens(state.wallets, stored.trackedTokens); dropUntrackedTokens(state.wallets, stored.trackedTokens);
} }
clearBalanceNotFetched(stored, readTokens);
state.lastBalanceRefresh = Date.now(); state.lastBalanceRefresh = Date.now();
return true; return true;
}); });
renderWalletList(); renderWalletList();
if (state.currentView === "address") addressDetail.renderBalances();
if (state.currentView === "address-token") addressToken.renderBalance();
} catch (e) { } catch (e) {
// Every call site fires this and walks away — the boot below, the ten // Every call site fires this and walks away — the boot below, the ten
// second interval, and eight views through ctx — so it must never // second interval, and eight views through ctx — so it must never
+9 -2
View File
@@ -1,4 +1,11 @@
const { $, showView, showFlash, escapeHtml, goBack } = require("./helpers"); const {
$,
showView,
showFlash,
escapeHtml,
goBack,
trackToken,
} = require("./helpers");
const { getTopTokens } = require("../../shared/tokenList"); const { getTopTokens } = require("../../shared/tokenList");
const { state, saveState, currentNetwork } = require("../../shared/state"); const { state, saveState, currentNetwork } = require("../../shared/state");
const { lookupTokenInfo } = require("../../shared/balances"); const { lookupTokenInfo } = require("../../shared/balances");
@@ -72,7 +79,7 @@ function init(ctx) {
return; return;
} }
log.infof("Adding token", info.symbol, contractAddr); log.infof("Adding token", info.symbol, contractAddr);
state.trackedTokens.push({ trackToken({
address: contractAddr, address: contractAddr,
symbol: info.symbol, symbol: info.symbol,
decimals: info.decimals, decimals: info.decimals,
+19 -10
View File
@@ -66,11 +66,27 @@ function show() {
}); });
$("address-line").dataset.full = addr.address; $("address-line").dataset.full = addr.address;
attachCopyHandlers($("address-line")); attachCopyHandlers($("address-line"));
const usdTotal = formatAddressTotal(getAddressValue(addr));
$("address-usd-total").innerHTML = escapeHtml(usdTotal) || " ";
const ensEl = $("address-ens"); const ensEl = $("address-ens");
// ENS is now shown inside renderAddressHtml, hide the separate element // ENS is now shown inside renderAddressHtml, hide the separate element
ensEl.classList.add("hidden"); ensEl.classList.add("hidden");
renderBalances();
// Only Blockscout reports the tokens the user has not tracked.
$("address-tokens-note").classList.toggle("hidden", !!state.useBlockscout);
renderSendTokenSelect(addr);
$("tx-list").innerHTML =
'<div class="text-muted text-xs py-1">Loading...</div>';
showView("address");
loadTransactions(addr.address);
}
// The USD total and the balance list. Drawn again by each balance refresh
// that returns while this screen is up (doRefreshAndRender() in
// src/popup/index.js), which leaves the rest of the screen as it is.
function renderBalances() {
const addr =
state.wallets[state.selectedWallet].addresses[state.selectedAddress];
const usdTotal = formatAddressTotal(getAddressValue(addr));
$("address-usd-total").innerHTML = escapeHtml(usdTotal) || "&nbsp;";
$("address-balances").innerHTML = balanceLinesForAddress( $("address-balances").innerHTML = balanceLinesForAddress(
addr, addr,
state.trackedTokens, state.trackedTokens,
@@ -84,13 +100,6 @@ function show() {
ctx.showAddressToken(); ctx.showAddressToken();
}); });
}); });
// Only Blockscout reports the tokens the user has not tracked.
$("address-tokens-note").classList.toggle("hidden", !!state.useBlockscout);
renderSendTokenSelect(addr);
$("tx-list").innerHTML =
'<div class="text-muted text-xs py-1">Loading...</div>';
showView("address");
loadTransactions(addr.address);
} }
let loadedTxs = []; let loadedTxs = [];
@@ -287,4 +296,4 @@ function init(_ctx) {
exportPrivkey.init(); exportPrivkey.init();
} }
module.exports = { init, show }; module.exports = { init, show, renderBalances };
+48 -32
View File
@@ -49,37 +49,18 @@ function show() {
const addr = wallet.addresses[state.selectedAddress]; const addr = wallet.addresses[state.selectedAddress];
const ai = state.selectedAddress; const ai = state.selectedAddress;
const tokenId = state.selectedToken; const tokenId = state.selectedToken;
// Determine token symbol and balance
let symbol, amount, price;
const knownToken = TOKEN_BY_ADDRESS.get(tokenId.toLowerCase()); const knownToken = TOKEN_BY_ADDRESS.get(tokenId.toLowerCase());
if (tokenId === "ETH") { currentSymbol =
symbol = nativeCurrency(); tokenId === "ETH"
amount = parseFloat(addr.balance || "0"); ? nativeCurrency()
price = getPrice("ETH"); : resolveSymbol(tokenId, addr.tokenBalances, state.trackedTokens);
} else {
const tb = (addr.tokenBalances || []).find(
(t) => t.address.toLowerCase() === tokenId.toLowerCase(),
);
symbol = resolveSymbol(
tokenId,
addr.tokenBalances,
state.trackedTokens,
);
// null when the scale is unknown: no quantity to show, and none to
// price. balanceLine() states that rather than printing 0.0000.
amount = tb ? unknownableAmount(tb.balance) : 0;
price = getPrice(symbol);
}
currentSymbol = symbol;
$("address-token-title").textContent = $("address-token-title").textContent =
wallet.name + wallet.name +
" \u2014 Address " + " \u2014 Address " +
(ai + 1) + (ai + 1) +
" \u2014 " + " \u2014 " +
displaySymbol(symbol); displaySymbol(currentSymbol);
// Blockie // Blockie
const blockieEl = $("address-token-jazzicon"); const blockieEl = $("address-token-jazzicon");
@@ -101,13 +82,7 @@ function show() {
$("address-token-line").dataset.full = addr.address; $("address-token-line").dataset.full = addr.address;
attachCopyHandlers($("address-token-line")); attachCopyHandlers($("address-token-line"));
// USD total for this token only renderBalance();
const usdVal = price && amount !== null ? amount * price : null;
const usdStr = formatUsd(usdVal);
$("address-token-usd-total").innerHTML = escapeHtml(usdStr) || "&nbsp;";
// Single token balance line (no tokenId — not clickable here)
$("address-token-balance").innerHTML = balanceLine(symbol, amount, price);
// Token contract details (ERC-20 only) // Token contract details (ERC-20 only)
const contractInfo = $("address-token-contract-info"); const contractInfo = $("address-token-contract-info");
@@ -169,6 +144,47 @@ function show() {
loadTransactions(addr.address, tokenId); loadTransactions(addr.address, tokenId);
} }
// The USD total and the balance line of the selected token. Drawn again by
// each balance refresh that returns while this screen is up
// (doRefreshAndRender() in src/popup/index.js), which leaves the rest of the
// screen as it is.
function renderBalance() {
const addr =
state.wallets[state.selectedWallet].addresses[state.selectedAddress];
const tokenId = state.selectedToken;
let amount, price;
if (tokenId === "ETH") {
amount = parseFloat(addr.balance || "0");
price = getPrice("ETH");
} else {
const id = tokenId.toLowerCase();
const tb = (addr.tokenBalances || []).find(
(t) => t.address.toLowerCase() === id,
);
const tracked = state.trackedTokens.find(
(t) => t.address.toLowerCase() === id,
);
// null when the scale is unknown, or when no refresh has read the
// balance of a token just added: no quantity to show, and none to
// price. balanceLine() states that rather than printing 0.0000.
if (tb) amount = unknownableAmount(tb.balance);
else amount = tracked && tracked.balanceNotFetched ? null : 0;
price = getPrice(currentSymbol);
}
// USD total for this token only
const usdVal = price && amount !== null ? amount * price : null;
const usdStr = formatUsd(usdVal);
$("address-token-usd-total").innerHTML = escapeHtml(usdStr) || "&nbsp;";
// Single token balance line (no tokenId — not clickable here)
$("address-token-balance").innerHTML = balanceLine(
currentSymbol,
amount,
price,
);
}
async function loadTransactions(address, tokenId) { async function loadTransactions(address, tokenId) {
try { try {
const rawTxs = await fetchRecentTransactions( const rawTxs = await fetchRecentTransactions(
@@ -348,4 +364,4 @@ function init(_ctx) {
}); });
} }
module.exports = { init, show }; module.exports = { init, show, renderBalance };
+11 -1
View File
@@ -417,6 +417,15 @@ function balanceLine(symbol, amount, price, tokenId) {
); );
} }
// Tracks `token` on the active network, as every add path on AddToken and
// SettingsAddToken does. The tracked record carries `balanceNotFetched: true`
// until a balance refresh has read the token's balance at every address
// (doRefreshAndRender() in src/popup/index.js). Until then, an address with no
// balance row for the token shows `quantity unknown` for it, not 0.0000.
function trackToken(token) {
state.trackedTokens.push({ ...token, balanceNotFetched: true });
}
function balanceLinesForAddress(addr, trackedTokens, showZero) { function balanceLinesForAddress(addr, trackedTokens, showZero) {
let html = balanceLine( let html = balanceLine(
nativeCurrency(), nativeCurrency(),
@@ -449,7 +458,7 @@ function balanceLinesForAddress(addr, trackedTokens, showZero) {
if (seen.has(t.address.toLowerCase())) continue; if (seen.has(t.address.toLowerCase())) continue;
html += balanceLine( html += balanceLine(
t.symbol, t.symbol,
0, t.balanceNotFetched ? null : 0,
getPrice(t.symbol), getPrice(t.symbol),
t.address.toLowerCase(), t.address.toLowerCase(),
); );
@@ -829,6 +838,7 @@ module.exports = {
flashCopyFeedback, flashCopyFeedback,
balanceLine, balanceLine,
balanceLinesForAddress, balanceLinesForAddress,
trackToken,
addressHoldsFunds, addressHoldsFunds,
keyMaterialName, keyMaterialName,
unknownableAmount, unknownableAmount,
+11 -4
View File
@@ -1,4 +1,11 @@
const { $, showView, showFlash, escapeHtml, goBack } = require("./helpers"); const {
$,
showView,
showFlash,
escapeHtml,
goBack,
trackToken,
} = require("./helpers");
const { getTopTokens } = require("../../shared/tokenList"); const { getTopTokens } = require("../../shared/tokenList");
const { state, saveState, currentNetwork } = require("../../shared/state"); const { state, saveState, currentNetwork } = require("../../shared/state");
const { lookupTokenInfo } = require("../../shared/balances"); const { lookupTokenInfo } = require("../../shared/balances");
@@ -43,7 +50,7 @@ function renderTop10() {
decimals: parseInt(btn.dataset.decimals, 10), decimals: parseInt(btn.dataset.decimals, 10),
name: btn.dataset.name || btn.dataset.symbol, name: btn.dataset.name || btn.dataset.symbol,
}; };
state.trackedTokens.push(token); trackToken(token);
await saveState(); await saveState();
showFlash("Added " + token.symbol); showFlash("Added " + token.symbol);
renderTop10(); renderTop10();
@@ -110,7 +117,7 @@ function init(_ctx) {
decimals: parseInt(opt.dataset.decimals, 10), decimals: parseInt(opt.dataset.decimals, 10),
name: opt.dataset.name || opt.dataset.symbol, name: opt.dataset.name || opt.dataset.symbol,
}; };
state.trackedTokens.push(token); trackToken(token);
await saveState(); await saveState();
showFlash("Added " + token.symbol); showFlash("Added " + token.symbol);
renderTop10(); renderTop10();
@@ -156,7 +163,7 @@ function init(_ctx) {
return; return;
} }
log.infof("Adding token", info.symbol, addr); log.infof("Adding token", info.symbol, addr);
state.trackedTokens.push({ trackToken({
address: addr, address: addr,
symbol: info.symbol, symbol: info.symbol,
decimals: info.decimals, decimals: info.decimals,
+20 -4
View File
@@ -247,7 +247,11 @@ async function fetchTokenBalances(
// it has none. The failure is logged. A balance of zero gets no entry, as a // it has none. The failure is logged. A balance of zero gets no entry, as a
// zero Blockscout reports gets none: the balance lists take a tracked token's // zero Blockscout reports gets none: the balance lists take a tracked token's
// zero from the tracked list. A token whose symbol the spoof rule refuses gets // zero from the tracked list. A token whose symbol the spoof rule refuses gets
// no entry either, as in fetchTokenBalances(). // no entry either, as in fetchTokenBalances(), and its balance is not read.
//
// Resolves with `rows`, the entries, and `unread`, the tracked tokens whose
// balance was not read, as lowercased contract addresses. A token is unread
// when the spoof rule refuses it or its balanceOf fails.
// //
// `signal` is as for fetchTokenBalances(). // `signal` is as for fetchTokenBalances().
async function fetchTrackedTokenBalances( async function fetchTrackedTokenBalances(
@@ -288,12 +292,16 @@ async function fetchTrackedTokenBalances(
const reported = explorerRows ?? previous; const reported = explorerRows ?? previous;
const rows = []; const rows = [];
const unread = trackedTokens
.filter((token) => !listed.includes(token))
.map((token) => token.address.toLowerCase());
listed.forEach((token, i) => { listed.forEach((token, i) => {
const lower = token.address.toLowerCase(); const lower = token.address.toLowerCase();
const entryIn = (list) => const entryIn = (list) =>
list.find((row) => String(row.address).toLowerCase() === lower); list.find((row) => String(row.address).toLowerCase() === lower);
const raw = balances[i]; const raw = balances[i];
if (raw === null) { if (raw === null) {
unread.push(lower);
const kept = entryIn(previous) || entryIn(explorerRows || []); const kept = entryIn(previous) || entryIn(explorerRows || []);
if (kept) rows.push(kept); if (kept) rows.push(kept);
return; return;
@@ -314,12 +322,15 @@ async function fetchTrackedTokenBalances(
holders: entry ? entry.holders : null, holders: entry ? entry.holders : null,
}); });
}); });
return rows; return { rows, unread };
} }
// Fetch ETH balances, ENS names, and ERC-20 token balances for all addresses. // Fetch ETH balances, ENS names, and ERC-20 token balances for all addresses.
// `trackedTokens` are the tokens tracked on the active network. `signal` is as // `trackedTokens` are the tokens tracked on the active network. `signal` is as
// for fetchTokenBalances(). // for fetchTokenBalances().
//
// Resolves with the lowercased contract addresses of the tracked tokens whose
// balance it read at every address.
async function refreshBalances( async function refreshBalances(
wallets, wallets,
rpcUrl, rpcUrl,
@@ -332,6 +343,8 @@ async function refreshBalances(
const provider = getProvider(rpcUrl, networkId); const provider = getProvider(rpcUrl, networkId);
const tracked = trackedTokens || []; const tracked = trackedTokens || [];
const trackedSet = new Set(tracked.map((t) => t.address.toLowerCase())); const trackedSet = new Set(tracked.map((t) => t.address.toLowerCase()));
// The tracked tokens whose balance was not read at some address.
const unread = new Set();
const updates = []; const updates = [];
for (const wallet of wallets) { for (const wallet of wallets) {
@@ -406,12 +419,14 @@ async function refreshBalances(
signal, signal,
), ),
explorerRequest, explorerRequest,
]).then(([trackedRows, explorerRows]) => { ]).then(([trackedResult, explorerRows]) => {
for (const lower of trackedResult.unread) unread.add(lower);
const untrackedRows = (explorerRows ?? previous).filter( const untrackedRows = (explorerRows ?? previous).filter(
(row) => (row) =>
!trackedSet.has(String(row.address).toLowerCase()), !trackedSet.has(String(row.address).toLowerCase()),
); );
addr.tokenBalances = trackedRows.concat(untrackedRows); addr.tokenBalances =
trackedResult.rows.concat(untrackedRows);
log.debugf( log.debugf(
"Token balances", "Token balances",
addr.address, addr.address,
@@ -425,6 +440,7 @@ async function refreshBalances(
await Promise.all(updates); await Promise.all(updates);
log.debugf("refreshBalances done"); log.debugf("refreshBalances done");
return [...trackedSet].filter((lower) => !unread.has(lower));
} }
// Drops the balance of each token not in `trackedTokens` from every address. // Drops the balance of each token not in `trackedTokens` from every address.
+25 -2
View File
@@ -128,8 +128,9 @@ function currentNetwork() {
// The persisted fields as this page held them when its last loadState() // The persisted fields as this page held them when its last loadState()
// finished, or when its last successful saveState() began, with any network // finished, or when its last successful saveState() began, with any network
// switch saved elsewhere that this page has taken since (takeStoredNetwork()). // switch saved elsewhere that this page has taken since (takeStoredNetwork()).
// saveState() diffs the live state against this to find only the fields THIS // `baseline` also lacks any `balanceNotFetched` field that a balance refresh has
// page changed since. // deleted since (clearBalanceNotFetched()). saveState() diffs the live state
// against this to find only the fields THIS page changed since.
// //
// Deep-cloned, not a reference: callers mutate persisted objects and arrays // Deep-cloned, not a reference: callers mutate persisted objects and arrays
// in place (state.wallets.push(...)), and a reference baseline would mutate // in place (state.wallets.push(...)), and a reference baseline would mutate
@@ -613,6 +614,27 @@ function takeStoredNetwork(stored) {
copyChainSwitchFields(baseline, structuredClone(stored)); copyChainSwitchFields(baseline, structuredClone(stored));
} }
// Deletes `balanceNotFetched` from each tracked token whose lowercased
// contract address is in `addresses`. The field goes from `stored`, from
// `state` and from `baseline` alike. `stored` is the record a save of this
// page has just read (doRefreshAndRender() in src/popup/index.js calls this
// from `beforeWrite`). So the deletion is not a change this page made to its
// tracked tokens. Unless this page has changed its tracked tokens itself, the
// save then writes the stored list with only the field gone.
function clearBalanceNotFetched(stored, addresses) {
for (const list of [
stored.trackedTokens,
rawState.trackedTokens,
baseline.trackedTokens,
]) {
for (const token of list) {
if (addresses.includes(token.address.toLowerCase())) {
delete token.balanceNotFetched;
}
}
}
}
// Rejects with StateUnusableError for a stored record this build cannot make // Rejects with StateUnusableError for a stored record this build cannot make
// sense of. Nothing is assigned and `loaded` stays false in that case, so a // sense of. Nothing is assigned and `loaded` stays false in that case, so a
// caller that ignores the rejection gets StateNotLoadedError on the first // caller that ignores the rejection gets StateNotLoadedError on the first
@@ -659,6 +681,7 @@ module.exports = {
saveState, saveState,
onSaveFailure, onSaveFailure,
takeStoredNetwork, takeStoredNetwork,
clearBalanceNotFetched,
loadState, loadState,
currentAddress, currentAddress,
currentNetwork, currentNetwork,
+32 -103
View File
@@ -1244,10 +1244,6 @@ function decode(data, toAddress, chainId, sources, fromAddress) {
// comes from the transaction's value. A step paid from the router // comes from the transaction's value. A step paid from the router
// takes nothing from the sender. // takes nothing from the sender.
let inputPaidByUser = false; let inputPaidByUser = false;
// The recipient of a WRAP_ETH that set the input side, as written,
// when it is not the router; otherwise null. That WRAP_ETH pays its
// WETH there, not to a swap step (see the Moved to lines).
let wrapEthRecipient = null;
// The last PERMIT2_PERMIT this decoder read before a step set the // The last PERMIT2_PERMIT this decoder read before a step set the
// input side, or null (see permitStands after the loop). // input side, or null (see permitStands after the loop).
let permit = null; let permit = null;
@@ -1403,11 +1399,9 @@ function decode(data, toAddress, chainId, sources, fromAddress) {
// token, an UNWRAP_WETH of WETH, a WRAP_ETH of CONTRACT_BALANCE of // token, an UNWRAP_WETH of WETH, a WRAP_ETH of CONTRACT_BALANCE of
// ETH, a TRANSFER, PAY_PORTION, PAY_PORTION_FULL_PRECISION or // ETH, a TRANSFER, PAY_PORTION, PAY_PORTION_FULL_PRECISION or
// ACROSS_V4_DEPOSIT_V3 of all of it, or a swap step or V4 SETTLE paid // ACROSS_V4_DEPOSIT_V3 of all of it, or a swap step or V4 SETTLE paid
// from the router (see spendFromRouter()). A V4 SETTLE of ETH paid by // from the router (see spendFromRouter()). The value is the amount the
// the user spends the router's ETH too (see the V4_SWAP branch). The // router holds, in base units, when a WRAP_ETH stated it, otherwise
// value is the amount the router holds, in base units, when a // null.
// WRAP_ETH stated it, otherwise null. An UNWRAP_WETH into the router
// turns that amount of WETH into the same amount of ETH.
const heldByRouter = new Map(); const heldByRouter = new Map();
const isRouter = (recipient) => { const isRouter = (recipient) => {
const r = recipient.toLowerCase(); const r = recipient.toLowerCase();
@@ -1415,8 +1409,8 @@ function decode(data, toAddress, chainId, sources, fromAddress) {
}; };
// A swap step or V4 SETTLE pays `amount` of `token` from the router's // A swap step or V4 SETTLE pays `amount` of `token` from the router's
// own balance. CONTRACT_BALANCE pays all of it. Any other quantity // own balance. CONTRACT_BALANCE pays all of it. Any other quantity
// counts against a known amount the router holds, and the steps pay // counts against the amount a WRAP_ETH stated, and the steps pay all
// all of it once their amounts reach that one: a swap paid in ETH wraps // of it once their amounts reach that one: a swap paid in ETH wraps
// what its swap steps then spend. An amount that is not a quantity, // what its swap steps then spend. An amount that is not a quantity,
// such as the null decodeV4Swap() gives a SETTLE whose payment it // such as the null decodeV4Swap() gives a SETTLE whose payment it
// cannot tell, or one of a token whose amount is not known, pays out // cannot tell, or one of a token whose amount is not known, pays out
@@ -1793,9 +1787,6 @@ function decode(data, toAddress, chainId, sources, fromAddress) {
w.amount, w.amount,
); );
inputPaidByUser = true; inputPaidByUser = true;
if (!isRouter(w.recipient)) {
wrapEthRecipient = w.recipient;
}
} }
addPayee(w.recipient); addPayee(w.recipient);
// CONTRACT_BALANCE wraps all the router's ETH. // CONTRACT_BALANCE wraps all the router's ETH.
@@ -1824,45 +1815,12 @@ function decode(data, toAddress, chainId, sources, fromAddress) {
} else if (command === "V4_SWAP") { } else if (command === "V4_SWAP") {
const v4 = decodeV4Swap(inputs[i]); const v4 = decodeV4Swap(inputs[i]);
const inputSetBefore = inputEstablished; const inputSetBefore = inputEstablished;
// What the user pays the step, as decodeV4Swap() gives
// it, less the ETH the router already holds (below).
// Empty when the step cannot be read.
const paidByUser = [];
if (v4) { if (v4) {
// Each SETTLE paid from the router spends the amount // Each SETTLE paid from the router spends the amount
// decodeV4Swap() says it pays. // decodeV4Swap() says it pays.
for (const s of v4.settledFromRouter) { for (const s of v4.settledFromRouter) {
spendFromRouter(s.currency, s.amount); spendFromRouter(s.currency, s.amount);
} }
// V4Router pays ETH from the router's own ETH,
// whoever a SETTLE names as payer. So ETH the router
// holds from an earlier step pays first for the ETH
// the user would pay the step. The user pays only the
// rest. When this decoder does not know how much ETH
// the router holds, or how much the user would pay,
// it counts the router as paying all of that ETH.
for (const p of v4.paidByUser) {
if (
p.currency !==
"0x0000000000000000000000000000000000000000" ||
!heldByRouter.has(p.currency)
) {
paidByUser.push(p);
continue;
}
const held = heldByRouter.get(p.currency);
if (
typeof held === "bigint" &&
typeof p.amount === "bigint" &&
p.amount > held
) {
paidByUser.push({
currency: p.currency,
amount: p.amount - held,
});
}
spendFromRouter(p.currency, p.amount);
}
for (const t of v4.takes) { for (const t of v4.takes) {
if (!isHop(i, t.currency, t.recipient)) { if (!isHop(i, t.currency, t.recipient)) {
addPayee(t.recipient, t.currency); addPayee(t.recipient, t.currency);
@@ -1887,10 +1845,10 @@ function decode(data, toAddress, chainId, sources, fromAddress) {
commandNames[i] += " (could not be decoded)"; commandNames[i] += " (could not be decoded)";
} }
// The step's amount, if it sets the input side: what the // The step's amount, if it sets the input side: what the
// user pays it of its input currency (see paidByUser), // user pays it of its input currency (see
// or, when the user pays none of it, what its swap // decodeV4Swap()), or, when the user pays none of it,
// actions spend of it, whoever pays that. // what its swap actions spend of it, whoever pays that.
const paidIn = paidByUser.find( const paidIn = v4?.paidByUser.find(
(p) => p.currency === v4.tokenIn, (p) => p.currency === v4.tokenIn,
); );
const amountIn = paidIn ? paidIn.amount : v4?.amountIn; const amountIn = paidIn ? paidIn.amount : v4?.amountIn;
@@ -1944,9 +1902,11 @@ function decode(data, toAddress, chainId, sources, fromAddress) {
// router still runs it. // router still runs it.
const setInputHere = inputEstablished && !inputSetBefore; const setInputHere = inputEstablished && !inputSetBefore;
if (setInputHere) inputPaidByUser = paidIn !== undefined; if (setInputHere) inputPaidByUser = paidIn !== undefined;
for (const p of paidByUser) { if (v4) {
if (setInputHere && p === paidIn) continue; for (const p of v4.paidByUser) {
addUserPaid(p.currency, p.amount); if (setInputHere && p === paidIn) continue;
addUserPaid(p.currency, p.amount);
}
} }
if (!v4 || v4.settleUnread) { if (!v4 || v4.settleUnread) {
spentUnread(); spentUnread();
@@ -1994,23 +1954,15 @@ function decode(data, toAddress, chainId, sources, fromAddress) {
addPayee(u.recipient); addPayee(u.recipient);
// It pays out all the router's WETH, as ETH. Into the // It pays out all the router's WETH, as ETH. Into the
// router, the router then holds as ETH the WETH a // router, the router then holds as ETH the WETH a
// step paid it. That amount is known when the router // step paid it.
// held a known amount of WETH and no ETH before. const heldWeth = WETH_ADDRESSES.some((w) =>
const heldWeth = WETH_ADDRESSES.filter((w) =>
heldByRouter.has(w), heldByRouter.has(w),
); );
const ethAmount = WETH_ADDRESSES.forEach((w) => heldByRouter.delete(w));
heldWeth.length === 1 && if (isRouter(u.recipient) && heldWeth) {
!heldByRouter.has(
"0x0000000000000000000000000000000000000000",
)
? heldByRouter.get(heldWeth[0])
: null;
heldWeth.forEach((w) => heldByRouter.delete(w));
if (isRouter(u.recipient) && heldWeth.length > 0) {
heldByRouter.set( heldByRouter.set(
"0x0000000000000000000000000000000000000000", "0x0000000000000000000000000000000000000000",
ethAmount, null,
); );
} }
} else { } else {
@@ -2099,17 +2051,14 @@ function decode(data, toAddress, chainId, sources, fromAddress) {
permit.beforeEveryTake && permit.beforeEveryTake &&
!stepsUnread.some((step) => step > permit.step); !stepsUnread.some((step) => step > permit.step);
// What the steps take that the Amount line does not give, as // What the steps take that the Amount line does not give, as
// { token, amount, recipient }. A null token is a step this decoder // { token, amount }. A null token is a step this decoder did not read
// did not read (see spentUnread()), or a token it does not know. Only // (see spentUnread()), or a token it does not know.
// the take of a WRAP_ETH that pays elsewhere has a recipient (see
// wrapEthRecipient).
const spentFromSender = []; const spentFromSender = [];
let total = null; let total = null;
// The takes from the sender that `total` adds up, each a quantity, in // The takes from the sender that `total` adds up, each a quantity, as
// the shape of `spentFromSender`. When there is no Amount line, each // { token, amount }. When there is no Amount line, each gets lines of
// gets lines of its own (see below). The amount of a step that set // its own (see below). The amount of a step that set the input side
// the input side and is paid from the router counts in `total` but is // and is paid from the router counts in `total` but is not among them.
// not among them.
const inTotal = []; const inTotal = [];
// Whether the step that set the input side counts as a take from the // Whether the step that set the input side counts as a take from the
// sender, which may get lines of its own. The amount it stated counts // sender, which may get lines of its own. The amount it stated counts
@@ -2124,11 +2073,7 @@ function decode(data, toAddress, chainId, sources, fromAddress) {
if (!permitStands || sameAddress(inputToken, permit.token)) { if (!permitStands || sameAddress(inputToken, permit.token)) {
total = inputAmount; total = inputAmount;
if (typeof inputAmount === "bigint" && inputPaidByUser) { if (typeof inputAmount === "bigint" && inputPaidByUser) {
inTotal.push({ inTotal.push({ token: inputToken, amount: inputAmount });
token: inputToken,
amount: inputAmount,
recipient: wrapEthRecipient,
});
} }
if (hasFirstTake && !present(inputAmount)) { if (hasFirstTake && !present(inputAmount)) {
firstTakeUnstated = { token: inputToken, amount: null }; firstTakeUnstated = { token: inputToken, amount: null };
@@ -2136,11 +2081,7 @@ function decode(data, toAddress, chainId, sources, fromAddress) {
} else if (hasFirstTake) { } else if (hasFirstTake) {
// The step that set the input side spent a token other than the // The step that set the input side spent a token other than the
// permit's, or one not known, so its amount gets lines of its own. // permit's, or one not known, so its amount gets lines of its own.
spentFromSender.push({ spentFromSender.push({ token: inputToken, amount: inputAmount });
token: inputToken,
amount: inputAmount,
recipient: wrapEthRecipient,
});
} }
if (permitStands) inputToken = permit.token; if (permitStands) inputToken = permit.token;
for (const t of userPaid) { for (const t of userPaid) {
@@ -2319,9 +2260,7 @@ function decode(data, toAddress, chainId, sources, fromAddress) {
// What steps take from the sender beyond the Amount line, in the shape // What steps take from the sender beyond the Amount line, in the shape
// of the lines below for a PERMIT2_TRANSFER_FROM. An amount this // of the lines below for a PERMIT2_TRANSFER_FROM. An amount this
// decoder does not know is said so, and a step it did not read gets // decoder does not know is said so, and a step it did not read gets
// that one line alone. A take with no recipient goes to the swap step // that one line alone.
// that spends it. A take with a recipient goes there, and MSG_SENDER
// there is the sender.
for (const s of spentFromSender) { for (const s of spentFromSender) {
details.push({ details.push({
label: "Moved from the sender", label: "Moved from the sender",
@@ -2331,20 +2270,10 @@ function decode(data, toAddress, chainId, sources, fromAddress) {
}); });
if (present(s.token)) { if (present(s.token)) {
details.push(tokenMovedLine("Token moved", s.token, sources)); details.push(tokenMovedLine("Token moved", s.token, sources));
if (!present(s.recipient)) { details.push({
details.push({ label: "Moved to",
label: "Moved to", value: "The swap step that spends it",
value: "The swap step that spends it", });
});
} else if (s.recipient.toLowerCase() === MSG_SENDER) {
details.push({ label: "Moved to", value: "The sender" });
} else {
details.push({
label: "Moved to",
value: s.recipient,
address: s.recipient,
});
}
} }
} }
+441
View File
@@ -0,0 +1,441 @@
// After "Add" on AddToken, AddressDetail lists the new token. Its line reads
// `quantity unknown`, not 0.0000, until a balance refresh has read the token's
// balance at every address, even if the popup closes and opens again
// meanwhile. A token added on SettingsAddToken reads the same wherever it is
// listed. A refresh that returns draws the balances on AddressDetail or
// AddressToken again, so the fetched balance shows without the screen being
// reopened (https://git.eeqj.de/sneak/AutistMask/issues/516).
//
// The tracked token's record carries `balanceNotFetched` until a refresh has
// read the token's balance. Removing the token removes that record. A network
// switch keeps each network's records apart. A refresh takes the field off the
// stored record's tokens and keeps another page's changes to the stored list.
//
// Driven through the real popup over a stored profile on Ethereum Mainnet,
// with "Show tracked tokens with zero balance" on, as it is by default.
const {
bootPopup,
cleanupPopup,
unversionedValidProfile,
} = require("./support/popupBoot");
// Tracked by nobody until a test adds it.
const NEW_TOKEN = "0xBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBB";
// A holding of a million NEW_TOKEN, as refreshBalances() stores it.
const MILLION = {
address: NEW_TOKEN,
name: "New Token",
symbol: "NEW",
decimals: 18,
balance: "1000000.0",
holders: 3,
};
// NEW_TOKEN as "Add" on AddToken tracks it, once a refresh has read its
// balance.
const NEW_TRACKED = {
address: NEW_TOKEN,
symbol: "NEW",
name: "New Token",
decimals: 18,
};
// A token that another popup page tracks.
const OTHER_TOKEN = {
address: "0xCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCC",
symbol: "OTH",
name: "Other Token",
decimals: 18,
};
afterEach(() => {
cleanupPopup();
});
// The popup reopened onto AddressDetail for the one address.
function bootOnAddress(extra) {
return bootPopup(
unversionedValidProfile({
currentView: "address",
selectedWallet: 0,
selectedAddress: 0,
...extra,
}),
);
}
// Holds the next balance refresh open. The returned function lets it finish
// with the address's ETH balance at 2 and `tokenBalances` as its token
// entries, having read the balance of every token tracked when it started.
// Given null, it finishes having read no token's balance, as when every
// balanceOf fails, and leaves the token entries as they were.
function holdNextRefresh(page) {
const { refreshBalances } = require("../src/shared/balances");
let release;
refreshBalances.mockImplementationOnce(
async (wallets, rpcUrl, explorerUrl, trackedTokens) => {
const read = trackedTokens.map((t) => t.address.toLowerCase());
const tokenBalances = await new Promise((resolve) => {
release = resolve;
});
wallets[0].addresses[0].balance = "2.0";
if (tokenBalances === null) return [];
wallets[0].addresses[0].tokenBalances = tokenBalances;
return read;
},
);
return async (tokenBalances) => {
release(tokenBalances);
await page.settle();
};
}
// Runs the ten-second refresh to the end, finishing it as holdNextRefresh()
// does with `tokenBalances`.
async function refreshOnce(page, tokenBalances) {
const finish = holdNextRefresh(page);
const ticking = page.tick();
await page.settle();
await finish(tokenBalances);
await ticking;
}
// "+ Token", NEW_TOKEN typed in, and "Add", with the contract lookup
// answering at once.
async function addNewToken(page) {
const { lookupTokenInfo } = require("../src/shared/balances");
lookupTokenInfo.mockResolvedValueOnce({
symbol: "NEW",
decimals: 18,
name: "New Token",
});
await page.click("btn-add-token");
page.node("add-token-address").value = NEW_TOKEN;
await page.click("btn-add-token-confirm");
}
// Settings' "+ Add token", NEW_TOKEN typed in, and "Add", with the contract
// lookup answering at once. It ends on SettingsAddToken.
async function addOnSettingsAddToken(page) {
const { lookupTokenInfo } = require("../src/shared/balances");
lookupTokenInfo.mockResolvedValueOnce({
symbol: "NEW",
decimals: 18,
name: "New Token",
});
await page.click("btn-settings-add-token");
page.node("settings-addtoken-address").value = NEW_TOKEN;
await page.click("btn-settings-addtoken-manual");
}
// The "[x]" button Settings draws beside the first tracked token. The page
// stub does not turn the markup Settings draws into elements. So the list
// hands Settings a stand-in for that button each time it is drawn, and
// `press()` presses the last one drawn. Call it before Settings opens.
function firstRemoveButton(page) {
const button = { press: null };
page.node("settings-tracked-tokens").querySelectorAll = () => [
{
dataset: { idx: "0" },
addEventListener: (name, fn) => {
button.press = fn;
},
},
];
return button;
}
// Picks `networkId` in the Settings network selector, as the user does.
async function chooseNetwork(page, networkId) {
const select = page.node("settings-network");
select.value = networkId;
for (const fn of select.listeners.change) await fn();
await page.settle();
}
// Another popup page saves `trackedTokens` as the tracked token list. This
// page is not told of the write.
function anotherPageTracks(page, trackedTokens) {
page.storage.write("autistmask", {
...page.storage.read("autistmask"),
trackedTokens,
});
}
// NEW_TOKEN's row in the balance list in element `id`, AddressDetail's unless
// another is named, as markup.
function newTokenRow(page, id = "address-balances") {
return page
.node(id)
.innerHTML.split("<div ")
.find((row) =>
row.includes('data-token="' + NEW_TOKEN.toLowerCase() + '"'),
);
}
// AddressDetail for the one address opened from Home, as its `[info]` button
// does.
async function openAddress(page) {
const { state } = require("../src/shared/state");
state.selectedWallet = 0;
state.selectedAddress = 0;
require("../src/popup/views/helpers").pushCurrentView();
require("../src/popup/views/addressDetail").show();
await page.settle();
}
// AddressToken for `token` opened from AddressDetail, as tapping the token's
// row there does.
async function openToken(page, token) {
const { state } = require("../src/shared/state");
state.selectedToken = token;
require("../src/popup/views/helpers").pushCurrentView();
require("../src/popup/views/addressToken").show();
await page.settle();
}
test("until the refresh Add started returns, the new token's line reads quantity unknown", async () => {
const page = await bootOnAddress();
expect(page.pageErrors).toEqual([]);
const finish = holdNextRefresh(page);
await addNewToken(page);
expect(page.visibleViews()).toEqual(["address"]);
const row = newTokenRow(page);
expect(row).toContain("quantity unknown");
expect(row).not.toContain("0.0000");
await finish([MILLION]);
});
test("once that refresh returns, AddressDetail shows the fetched balance without being reopened", async () => {
const page = await bootOnAddress();
const finish = holdNextRefresh(page);
await addNewToken(page);
// Stands for the transactions on the screen, which only show() replaces.
page.node("tx-list").innerHTML = "transactions on the screen";
await finish([MILLION]);
expect(page.visibleViews()).toEqual(["address"]);
expect(newTokenRow(page)).toContain("1000000.0000");
// Only the balances are drawn again, not the transaction list.
expect(page.node("tx-list").innerHTML).toBe("transactions on the screen");
});
test("a refresh already running when the token is added does not count as reading its balance", async () => {
const page = await bootOnAddress();
const finishRunning = holdNextRefresh(page);
const ticking = page.tick();
await page.settle();
await addNewToken(page);
await finishRunning([]);
await ticking;
expect(newTokenRow(page)).toContain("quantity unknown");
// The next one reads the token's balance, which is zero.
await refreshOnce(page, []);
expect(newTokenRow(page)).toContain("0.0000");
});
test("closed and opened again before any refresh has read its balance, the new token's line still reads quantity unknown", async () => {
const closed = await bootOnAddress();
holdNextRefresh(closed);
await addNewToken(closed);
cleanupPopup();
// The refresh this boot starts reads no token's balance: the boot's stub
// of refreshBalances() reads none.
const page = await bootPopup(undefined, { storage: closed.storage });
expect(page.visibleViews()).toEqual(["address"]);
const row = newTokenRow(page);
expect(row).toContain("quantity unknown");
expect(row).not.toContain("0.0000");
await refreshOnce(page, [MILLION]);
expect(newTokenRow(page)).toContain("1000000.0000");
});
test("a refresh that could not read the new token's balance leaves its line quantity unknown", async () => {
const page = await bootOnAddress();
const finish = holdNextRefresh(page);
await addNewToken(page);
await finish(null);
// Drawn again: the ETH balance it fetched is shown.
expect(page.node("address-balances").innerHTML).toContain("2.0000");
expect(newTokenRow(page)).toContain("quantity unknown");
});
test("AddressToken for the new token reads quantity unknown until the refresh returns, then the fetched balance", async () => {
const page = await bootOnAddress();
const finish = holdNextRefresh(page);
await addNewToken(page);
await openToken(page, NEW_TOKEN.toLowerCase());
expect(page.visibleViews()).toEqual(["address-token"]);
const before = page.node("address-token-balance").innerHTML;
expect(before).toContain("quantity unknown");
expect(before).not.toContain("0.0000");
await finish([MILLION]);
expect(page.node("address-token-balance").innerHTML).toContain(
"1000000.0000",
);
});
test("a token added by contract address on SettingsAddToken reads quantity unknown until the refresh returns", async () => {
const page = await bootPopup(unversionedValidProfile());
expect(page.visibleViews()).toEqual(["main"]);
const finish = holdNextRefresh(page);
await page.click("btn-settings");
await addOnSettingsAddToken(page);
await page.click("btn-settings-addtoken-back");
await page.click("btn-settings-back");
expect(page.visibleViews()).toEqual(["main"]);
const onHome = newTokenRow(page, "wallet-list");
expect(onHome).toContain("quantity unknown");
expect(onHome).not.toContain("0.0000");
await openAddress(page);
const onAddress = newTokenRow(page);
expect(onAddress).toContain("quantity unknown");
expect(onAddress).not.toContain("0.0000");
await finish([MILLION]);
expect(newTokenRow(page)).toContain("1000000.0000");
});
test("a refresh that returns while AddressToken is up draws its balance again", async () => {
const page = await bootPopup(
unversionedValidProfile({
currentView: "address-token",
viewStack: ["main", "address"],
selectedWallet: 0,
selectedAddress: 0,
selectedToken: "ETH",
}),
);
expect(page.visibleViews()).toEqual(["address-token"]);
expect(page.node("address-token-balance").innerHTML).toContain("1.5000");
await refreshOnce(page, null);
expect(page.node("address-token-balance").innerHTML).toContain("2.0000");
});
test("a token removed before any refresh has read its balance leaves nothing stored, and adding it again tracks it once", async () => {
const page = await bootPopup(unversionedValidProfile());
const removeButton = firstRemoveButton(page);
const stored = () => page.storage.read("autistmask");
await page.click("btn-settings");
await addOnSettingsAddToken(page);
// Settings opened again from Home draws its list with the token in it.
await page.click("btn-settings-addtoken-back");
await page.click("btn-settings-back");
await page.click("btn-settings");
await removeButton.press();
await page.settle();
expect(stored().trackedTokens).toEqual([]);
// Nothing in the stored record names the token any more.
expect(JSON.stringify(stored()).toLowerCase()).not.toContain(
NEW_TOKEN.toLowerCase(),
);
await addOnSettingsAddToken(page);
// A second add of the same token is refused.
page.node("settings-addtoken-address").value = NEW_TOKEN;
await page.click("btn-settings-addtoken-manual");
const added = { address: NEW_TOKEN, symbol: "NEW", decimals: 18 };
expect(stored().trackedTokens).toEqual([
{ ...added, name: "New Token", balanceNotFetched: true },
]);
await refreshOnce(page, []);
expect(stored().trackedTokens).toEqual([{ ...added, name: "New Token" }]);
});
test("a refresh on another network leaves the new token reading quantity unknown on its own", async () => {
// Sepolia tracks a token at the same contract address, also just added.
const sepoliaToken = {
address: NEW_TOKEN,
symbol: "SEP",
name: "Sepolia Token",
decimals: 18,
};
const page = await bootOnAddress({
networkTrackedTokens: {
sepolia: [{ ...sepoliaToken, balanceNotFetched: true }],
},
});
const finishMainnet = holdNextRefresh(page);
await addNewToken(page);
await page.click("btn-settings");
await chooseNetwork(page, "sepolia");
// The refresh Add started returns after the switch and writes nothing.
await finishMainnet([MILLION]);
// Sepolia's refresh reads the balance of its own token.
await refreshOnce(page, []);
const stored = page.storage.read("autistmask");
expect(stored.trackedTokens).toEqual([sepoliaToken]);
expect(stored.networkTrackedTokens.mainnet[0].balanceNotFetched).toBe(true);
await chooseNetwork(page, "mainnet");
await page.click("btn-settings-back");
expect(page.visibleViews()).toEqual(["address"]);
expect(newTokenRow(page)).toContain("quantity unknown");
await refreshOnce(page, [MILLION]);
expect(newTokenRow(page)).toContain("1000000.0000");
});
test("a refresh keeps a token that another page added after this page loaded", async () => {
const page = await bootOnAddress();
const finish = holdNextRefresh(page);
await addNewToken(page);
const otherAdded = { ...OTHER_TOKEN, balanceNotFetched: true };
anotherPageTracks(page, [
{ ...NEW_TRACKED, balanceNotFetched: true },
otherAdded,
]);
await finish([MILLION]);
expect(page.storage.read("autistmask").trackedTokens).toEqual([
NEW_TRACKED,
otherAdded,
]);
expect(newTokenRow(page)).toContain("1000000.0000");
});
test("a refresh does not bring back a token that another page removed after this page loaded", async () => {
const page = await bootOnAddress({ trackedTokens: [OTHER_TOKEN] });
const finish = holdNextRefresh(page);
await addNewToken(page);
anotherPageTracks(page, [{ ...NEW_TRACKED, balanceNotFetched: true }]);
await finish([MILLION]);
expect(page.storage.read("autistmask").trackedTokens).toEqual([
NEW_TRACKED,
]);
});
@@ -41,6 +41,7 @@ async function holdRefresh(page) {
holders: null, holders: null,
}, },
]; ];
return [];
}); });
const ticking = page.tick(); const ticking = page.tick();
await page.settle(); await page.settle();
@@ -720,6 +720,7 @@ describe("the popup", () => {
tokenRow(TRACKED, "TRK"), tokenRow(TRACKED, "TRK"),
tokenRow(UNTRACKED, "TST"), tokenRow(UNTRACKED, "TST"),
]; ];
return [];
}); });
const ticking = page.tick(); const ticking = page.tick();
await page.settle(); await page.settle();
@@ -764,6 +765,7 @@ describe("the popup", () => {
addr.tokenBalances = after addr.tokenBalances = after
? [tokenRow(TRACKED, "TRK"), tokenRow(UNTRACKED, "TST")] ? [tokenRow(TRACKED, "TRK"), tokenRow(UNTRACKED, "TST")]
: [tokenRow(TRACKED, "TRK")]; : [tokenRow(TRACKED, "TRK")];
return [];
}); });
anotherPageSaves(page, { useBlockscout: after }); anotherPageSaves(page, { useBlockscout: after });
+2 -1
View File
@@ -969,7 +969,8 @@ test("a token added by its contract address is listed on the address screen (#15
await visible(env.page, "#view-address"); await visible(env.page, "#view-address");
// No wait: the confirm renders the balance list before it shows the // No wait: the confirm renders the balance list before it shows the
// screen, and nothing renders the list again while the screen is up. // screen. The refresh it starts draws the list again, with the row still
// in it.
const row = env.page.locator( const row = env.page.locator(
'#address-balances [data-token="' + STUB_TOKEN.address + '"]', '#address-balances [data-token="' + STUB_TOKEN.address + '"]',
{ hasText: STUB_TOKEN.symbol }, { hasText: STUB_TOKEN.symbol },
+1
View File
@@ -48,6 +48,7 @@ async function boot(stored) {
for (const wallet of wallets) { for (const wallet of wallets) {
for (const addr of wallet.addresses) addr.balance = chainBalance; for (const addr of wallet.addresses) addr.balance = chainBalance;
} }
return [];
}); });
return { page, refreshBalances }; return { page, refreshBalances };
} }
+1
View File
@@ -88,6 +88,7 @@ describe.each([
showFlash: (msg) => flashes.push(msg), showFlash: (msg) => flashes.push(msg),
escapeHtml: (s) => s, escapeHtml: (s) => s,
goBack: () => {}, goBack: () => {},
trackToken: () => {},
})); }));
require("../src/popup/views/" + view).init({ require("../src/popup/views/" + view).init({
+3 -2
View File
@@ -279,10 +279,11 @@ async function bootPopup(stored, options) {
getAddressValue: () => ({ usd: null, partial: false }), getAddressValue: () => ({ usd: null, partial: false }),
})); }));
// scanForAddresses() answers in the real one's shape, a scan that found // scanForAddresses() answers in the real one's shape, a scan that found
// no used address: AddWallet reads `addresses` from it. // no used address: AddWallet reads `addresses` from it. refreshBalances()
// answers as a refresh that read no tracked token's balance.
jest.doMock("../../src/shared/balances", () => ({ jest.doMock("../../src/shared/balances", () => ({
fetchTokenBalances: jest.fn(async () => []), fetchTokenBalances: jest.fn(async () => []),
refreshBalances: jest.fn(async () => {}), refreshBalances: jest.fn(async () => []),
dropUntrackedTokens: jest.requireActual("../../src/shared/balances") dropUntrackedTokens: jest.requireActual("../../src/shared/balances")
.dropUntrackedTokens, .dropUntrackedTokens,
lookupTokenInfo: jest.fn(async () => null), lookupTokenInfo: jest.fn(async () => null),
+28
View File
@@ -307,3 +307,31 @@ test("a tracked token wearing a known symbol from another contract is not listed
); );
expect(first.tokenBalances).toEqual([]); expect(first.tokenBalances).toEqual([]);
}); });
test("the refresh resolves with each tracked token whose balance it read at every address", async () => {
const flaky = "0x9999999999999999999999999999999999999999";
holdings[TOKEN] = { [FIRST]: 2000000n, [SECOND]: 0n };
// balanceOf answers at FIRST and fails at SECOND.
holdings[flaky] = { [FIRST]: 2000000n };
const read = await refreshBalances(
[
{
addresses: [
{ address: FIRST, tokenBalances: [] },
{ address: SECOND, tokenBalances: [] },
],
},
],
RPC_URL,
EXPLORER_URL,
[
TRACKED,
{ address: flaky, symbol: "FLK", name: "Flaky", decimals: 6 },
// A known symbol from another contract: its balance is not read.
{ address: OTHER, symbol: "USDC", name: "Fake", decimals: 6 },
],
"mainnet",
new AbortController().signal,
);
expect(read).toEqual([TOKEN]);
});
+4 -2
View File
@@ -159,7 +159,9 @@ test("a token added by contract address on Sepolia is tracked on Sepolia only",
"sepolia", "sepolia",
expect.anything(), expect.anything(),
); );
expect(stored().trackedTokens).toEqual([SEPOLIA_TOKEN]); // No refresh has read the new token's balance yet.
const added = { ...SEPOLIA_TOKEN, balanceNotFetched: true };
expect(stored().trackedTokens).toEqual([added]);
await boot.click("btn-settings"); await boot.click("btn-settings");
await chooseNetwork(boot, "mainnet"); await chooseNetwork(boot, "mainnet");
@@ -171,7 +173,7 @@ test("a token added by contract address on Sepolia is tracked on Sepolia only",
await chooseNetwork(boot, "sepolia"); await chooseNetwork(boot, "sepolia");
expect(stored().networkId).toBe("sepolia"); expect(stored().networkId).toBe("sepolia");
expect(stored().trackedTokens).toEqual([SEPOLIA_TOKEN]); expect(stored().trackedTokens).toEqual([added]);
const onSepolia = boot.node("settings-tracked-tokens").innerHTML; const onSepolia = boot.node("settings-tracked-tokens").innerHTML;
expect(onSepolia).toContain("TST"); expect(onSepolia).toContain("TST");
expect(onSepolia).not.toContain("DAI"); expect(onSepolia).not.toContain("DAI");
-107
View File
@@ -2424,113 +2424,6 @@ describe("uniswap decoder", () => {
expect(linesBetweenTokens(result)).toEqual(lines); expect(linesBetweenTokens(result)).toEqual(lines);
}); });
// https://git.eeqj.de/sneak/AutistMask/issues/665 — a WRAP_ETH that
// sets the input side and pays its WETH to anyone but the router
// names that recipient on its Moved to line. On next each row read
// The swap step that spends it.
const ONE_ETH = 1000000000000000000n;
const MSG_SENDER = "0x0000000000000000000000000000000000000001";
// The lines of a WRAP_ETH of 1 ETH whose Moved to line reads `to`.
const wrapLines = (to) => [
["Moved from the sender", "1.0000 ETH"],
["Token moved", "ETH"],
["Moved to", to],
];
test.each([
{
kind: "a WRAP_ETH of 1 ETH to another address, then an EXECUTE_SUB_PLAN",
commands: [0x0b, 0x21],
inputs: [encodeWrapEth(OTHER_ADDR, ONE_ETH), SUB_PLAN],
lines: [
...wrapLines(OTHER_ADDR),
["Moved from the sender", UNDECODED],
],
},
{
kind: "a WRAP_ETH of 1 ETH to address(1), then an EXECUTE_SUB_PLAN",
commands: [0x0b, 0x21],
inputs: [encodeWrapEth(MSG_SENDER, ONE_ETH), SUB_PLAN],
lines: [
...wrapLines("The sender"),
["Moved from the sender", UNDECODED],
],
},
{
kind: "a PERMIT2_PERMIT of 5,000 USDT to the router, a WRAP_ETH of 1 ETH to another address, then a V3 exact-in of 600 USDT",
commands: [0x0a, 0x0b, 0x00],
inputs: [
encodePermit2(USDT_ADDR, 5000000000n, ROUTER_ADDR),
encodeWrapEth(OTHER_ADDR, ONE_ETH),
V3_600,
],
lines: [["Amount", "5000.0000 USDT"], ...wrapLines(OTHER_ADDR)],
},
])("$kind", ({ commands, inputs, lines }) => {
const result = decodeSteps(commands, inputs);
expect(linesBetweenTokens(result)).toEqual(lines);
});
// https://git.eeqj.de/sneak/AutistMask/issues/665 — V4Router pays ETH
// from the router's own ETH, whoever a SETTLE names as payer. ETH the
// router holds from an UNWRAP_WETH into it pays first, so the sender
// pays only the ETH beyond it. On next each row also took the V4
// step's whole ETH from the sender: 1 ETH more in the first two, and
// 1.5 ETH in the last.
const unwrapIntoRouter = encodeWrapEth(ROUTER_ADDR, 0n); // UNWRAP_WETH, same encoding
// A V4 step swapping `amount` of ETH for USDC, with a SETTLE of
// OPEN_DELTA by the user.
const v4EthForUsdc = (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, 0n, true),
encodeV4TakeAll(USDC_ADDR, 0n),
],
);
test.each([
{
kind: "a V3 exact-in of 600 USDT for WETH paid to the router, an UNWRAP_WETH into the router, then a V4 swap of 1 ETH that the user settles",
commands: [0x00, 0x0c, 0x10],
inputs: [
encodeV3SwapExactIn(ROUTER_ADDR, USDT_600, 1n, [
USDT_ADDR,
WETH_ADDR,
]),
unwrapIntoRouter,
v4EthForUsdc(ONE_ETH),
],
lines: [["Amount", "600.0000 USDT"]],
},
{
kind: "a WRAP_ETH of 1 ETH into the router, an UNWRAP_WETH into the router, then a V4 swap of 1 ETH that the user settles",
commands: [0x0b, 0x0c, 0x10],
inputs: [
encodeWrapEth(ROUTER_ADDR, ONE_ETH),
unwrapIntoRouter,
v4EthForUsdc(ONE_ETH),
],
lines: [["Amount", "1.0000 ETH"]],
},
{
kind: "a WRAP_ETH of 1 ETH into the router, an UNWRAP_WETH into the router, then a V4 swap of 1.5 ETH that the user settles",
commands: [0x0b, 0x0c, 0x10],
inputs: [
encodeWrapEth(ROUTER_ADDR, ONE_ETH),
unwrapIntoRouter,
v4EthForUsdc((ONE_ETH * 3n) / 2n),
],
lines: [["Amount", "1.5000 ETH"]],
},
])("$kind", ({ commands, inputs, lines }) => {
const result = decodeSteps(commands, inputs);
expect(linesBetweenTokens(result)).toEqual(lines);
});
// A V3_SWAP_EXACT_OUT the user pays for, of at most `amountInMax` // A V3_SWAP_EXACT_OUT the user pays for, of at most `amountInMax`
// USDT for USDC. // USDT for USDC.
const v3ExactOut = (amountInMax) => const v3ExactOut = (amountInMax) =>