fix: a V4 SETTLE of ETH paid from the router reads as moved from the sender (closes #682)
V4Router pays a SETTLE of ETH from the router's own ETH, whichever payer it names, and the router holds the transaction's value. A V4 SETTLE of ETH that names the router as payer now counts as ETH the user pays. With no ETH left in the router by an earlier step, it reads as a SETTLE the user pays. When an earlier step left ETH there, it gets lines of its own reading Up to and the amount. When the amount is not known, as for CONTRACT_BALANCE, its Moved from the sender line reads Unknown (could not be decoded). No line now shows less ETH than such a SETTLE can take. Model: opus-5-5
This commit was merged in pull request #686.
This commit is contained in:
+80
-25
@@ -1240,9 +1240,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).
|
||||
@@ -1338,7 +1339,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
|
||||
@@ -1815,6 +1818,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.
|
||||
@@ -1845,10 +1883,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;
|
||||
@@ -1902,10 +1940,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 +2065,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
|
||||
@@ -2060,14 +2112,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
|
||||
@@ -2093,7 +2145,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);
|
||||
@@ -2196,8 +2249,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 };
|
||||
}
|
||||
@@ -2210,7 +2264,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
|
||||
@@ -2270,7 +2324,8 @@ 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)) {
|
||||
|
||||
Reference in New Issue
Block a user