fix: WETH paid to the user before an UNWRAP_WETH reads as WETH (closes #607)

An UNWRAP_WETH made Token Out ETH whenever the output side was WETH,
though the router unwraps only the WETH it holds. decode() now records
where the step that set the output side paid its output, and an
UNWRAP_WETH makes the output ETH only when that step paid WETH to the
router and the router still holds WETH. When that step paid only part
of its WETH to the router, or made a payout the decoder cannot read,
the output reads ETH with no minimum: the decoder does not count how
much of that step's minimum reaches the router, nor read the
UNWRAP_WETH's own minimum. A BALANCE_CHECK_ERC20 pays nobody, so it is
never read as unwrapped. README Display Consistency says the same.

Model: opus-5-5

tests/uniswapRecipient.test.js

@@ -7,9 +7,11 @@
 // (https://git.eeqj.de/sneak/AutistMask/issues/592), the address whose
 // balance a BALANCE_CHECK_ERC20 checks
 // (https://git.eeqj.de/sneak/AutistMask/issues/600), any token a swap
-// leaves in the router (https://git.eeqj.de/sneak/AutistMask/issues/606), and
+// leaves in the router (https://git.eeqj.de/sneak/AutistMask/issues/606),
 // what each PERMIT2_TRANSFER_FROM moves
-// (https://git.eeqj.de/sneak/AutistMask/issues/611).
+// (https://git.eeqj.de/sneak/AutistMask/issues/611), and when an
+// UNWRAP_WETH makes the output ETH
+// (https://git.eeqj.de/sneak/AutistMask/issues/607).
 //
 // Every swap command, SWEEP, WRAP_ETH, UNWRAP_WETH, TRANSFER, PAY_PORTION,
 // PAY_PORTION_FULL_PRECISION, PERMIT2_TRANSFER_FROM, ACROSS_V4_DEPOSIT_V3 and
@@ -268,18 +270,28 @@ const SWAP_USDT_FOR_ETH = [
         [[[ZERO, USDT, 500, 10, ZERO], false, USDT_2000, ONE_WETH, "0x"]],
     ),
 ];
+const SWAP_USDT_FOR_WETH = [
+    0x06, // SWAP_EXACT_IN_SINGLE
+    coder.encode(
+        [
+            "tuple(tuple(address,address,uint24,int24,address),bool,uint128,uint128,bytes)",
+        ],
+        [[[USDT, WETH, 500, 10, ZERO], true, USDT_2000, ONE_WETH, "0x"]],
+    ),
+];
 // SWAP_EXACT_IN_SINGLE with no parameters, which cannot be read.
 const UNREADABLE_SWAP = [0x06, "0x"];
 const SETTLE_USDT = [
     0x0b,
     coder.encode(["address", "uint256", "bool"], [USDT, 0n, true]),
 ];
-function take(currency, recipient) {
+// A TAKE of `amount`, by default zero: the open delta, all the step owes.
+function take(currency, recipient, amount = 0n) {
     return [
         0x0e,
         coder.encode(
             ["address", "address", "uint256"],
-            [currency, recipient, 0n],
+            [currency, recipient, amount],
         ),
     ];
 }
@@ -531,7 +543,7 @@ describe("an output left in the router is not received", () => {
         {
             kind: "an UNWRAP_WETH to the user, then the swap",
             data: execute(unwrapWeth(MSG_SENDER), toRouter),
-            min: "1.0000 ETH",
+            min: "1.0000 WETH",
         },
         {
             kind: "the swap, then a WRAP_ETH of zero to the user",
@@ -568,6 +580,171 @@ describe("an output left in the router is not received", () => {
     });
 });
 
+// https://git.eeqj.de/sneak/AutistMask/issues/607: an UNWRAP_WETH pays out,
+// as ETH, the WETH the router holds when it runs. Token Out read ETH whenever
+// the output side was WETH, so a swap that paid its WETH to the user before
+// the UNWRAP_WETH read as ETH, though the user receives WETH.
+describe("an UNWRAP_WETH makes the output ETH only when the router holds it", () => {
+    test("a swap paying its WETH to the user, then an UNWRAP_WETH, reads as WETH", () => {
+        const result = decode(
+            execute(swapToWeth(MSG_SENDER), unwrapWeth(MSG_SENDER)),
+        );
+        expect(result.name).toBe("Swap USDT → WETH");
+        expect(labels(result)).toEqual(PAID_TO_USER);
+        expect(detail(result, "Min. received").value).toBe("1.0000 WETH");
+    });
+
+    test("a swap paying its WETH to the router, then an UNWRAP_WETH to the user, reads as ETH", () => {
+        const result = decode(
+            execute(swapToWeth(ADDRESS_THIS), unwrapWeth(MSG_SENDER)),
+        );
+        expect(result.name).toBe("Swap USDT → ETH");
+        expect(labels(result)).toEqual(PAID_TO_USER);
+        expect(detail(result, "Min. received").value).toBe("1.0000 ETH");
+    });
+
+    // The SWEEP pays the user all the WETH the router holds, so the
+    // UNWRAP_WETH finds none of it.
+    test("a swap paying its WETH to the router, then a SWEEP of it to the user, then an UNWRAP_WETH, reads as WETH", () => {
+        const result = decode(
+            execute(
+                swapToWeth(ADDRESS_THIS),
+                sweep(WETH, MSG_SENDER),
+                unwrapWeth(MSG_SENDER),
+            ),
+        );
+        expect(result.name).toBe("Swap USDT → WETH");
+        expect(detail(result, "Min. received").value).toBe("1.0000 WETH");
+    });
+
+    // The user receives the first step's WETH as WETH and the second's as
+    // ETH. The second step sets the output side and pays its WETH to the
+    // router, so the output reads as ETH with the second step's minimum.
+    test("two swaps, the second paying its WETH to the router, then an UNWRAP_WETH, reads as ETH", () => {
+        const result = decode(
+            execute(
+                swapToWeth(MSG_SENDER),
+                v2Swap(0x08, ADDRESS_THIS, USDC_1990, ONE_WETH / 2n, [
+                    USDC,
+                    WETH,
+                ]),
+                unwrapWeth(MSG_SENDER),
+            ),
+        );
+        expect(result.name).toBe("Swap USDT → ETH");
+        expect(detail(result, "Min. received").value).toBe("0.5000 ETH");
+    });
+
+    // The same two swaps the other way round. The user receives the first
+    // step's WETH as ETH and the second's as WETH. The second step sets the
+    // output side and pays its WETH to the user, so the output reads as WETH
+    // with the second step's minimum, though the router holds the first's.
+    test("two swaps, the second paying its WETH to the user, then an UNWRAP_WETH, reads as WETH", () => {
+        const result = decode(
+            execute(
+                v2Swap(0x08, ADDRESS_THIS, USDC_1990, ONE_WETH / 2n, [
+                    USDC,
+                    WETH,
+                ]),
+                swapToWeth(MSG_SENDER),
+                unwrapWeth(MSG_SENDER),
+            ),
+        );
+        expect(result.name).toBe("Swap USDC → WETH");
+        expect(detail(result, "Min. received").value).toBe("1.0000 WETH");
+    });
+
+    // One V4 step buys at least 1 WETH and TAKEs 0.6 WETH to the user and the
+    // rest to the router. The user receives 0.6 WETH and the rest as ETH.
+    // Neither minimum is shown: the decoder does not count how much of the
+    // step's minimum reaches the router, nor read the UNWRAP_WETH's own.
+    test("one V4 step paying part of its WETH to the user and the rest to the router, then an UNWRAP_WETH, reads as ETH with no minimum", () => {
+        const result = decode(
+            execute(
+                v4Swap(
+                    SWAP_USDT_FOR_WETH,
+                    SETTLE_USDT,
+                    take(WETH, MSG_SENDER, (ONE_WETH * 6n) / 10n),
+                    take(WETH, ADDRESS_THIS),
+                ),
+                unwrapWeth(MSG_SENDER),
+            ),
+        );
+        expect(result.name).toBe("Swap USDT → ETH");
+        expect(labels(result)).toEqual([
+            "Protocol",
+            "Token In",
+            "Amount",
+            "Token Out",
+            "Steps",
+            "Deadline",
+        ]);
+    });
+
+    // A TAKE the decoder cannot read may pay part of the WETH to the user.
+    test("one V4 step paying WETH to the router beside a TAKE that cannot be read, then an UNWRAP_WETH, reads as ETH with no minimum", () => {
+        const result = decode(
+            execute(
+                v4Swap(
+                    SWAP_USDT_FOR_WETH,
+                    SETTLE_USDT,
+                    withDirtyWord(take(WETH, MSG_SENDER), 1),
+                    take(WETH, ADDRESS_THIS),
+                ),
+                unwrapWeth(MSG_SENDER),
+            ),
+        );
+        expect(result.name).toBe("Swap USDT → ETH");
+        expect(detail(result, "Min. received")).toBeUndefined();
+        expect(detail(result, "Min. paid out")).toBeUndefined();
+    });
+
+    // A step after the UNWRAP_WETH that sets the output side sets it anew.
+    test("a swap paying WETH to the user after an UNWRAP_WETH of an earlier swap's WETH reads as WETH", () => {
+        const result = decode(
+            execute(
+                swapToWeth(ADDRESS_THIS),
+                unwrapWeth(MSG_SENDER),
+                v2Swap(0x08, MSG_SENDER, USDC_1990, ONE_WETH / 2n, [
+                    USDC,
+                    WETH,
+                ]),
+            ),
+        );
+        expect(result.name).toBe("Swap USDT → WETH");
+        expect(detail(result, "Min. received").value).toBe("0.5000 WETH");
+    });
+
+    // The EXECUTE_SUB_PLAN's own steps, which the decoder does not read, buy
+    // the user USDC as well, so Token Out is not named.
+    test("a swap paying its WETH to the router, then an UNWRAP_WETH, then an EXECUTE_SUB_PLAN, names no Token Out", () => {
+        const subPlan = [
+            0x21,
+            coder.encode(
+                ["bytes", "bytes[]"],
+                [
+                    "0x00",
+                    [
+                        v3SwapExactIn(
+                            MSG_SENDER,
+                            USDT_2000,
+                            USDC_1990,
+                            USDT,
+                            USDC,
+                        )[1],
+                    ],
+                ],
+            ),
+        ];
+        const result = decode(
+            execute(swapToWeth(ADDRESS_THIS), unwrapWeth(MSG_SENDER), subPlan),
+        );
+        expect(result.name).toBe("Uniswap Swap");
+        expect(detail(result, "Token Out").value).toBe(UNDECODED);
+        expect(detail(result, "Min. received")).toBeUndefined();
+    });
+});
+
 // https://git.eeqj.de/sneak/AutistMask/issues/606: any token a step pays the
 // router stays there unless a later step pays out or spends all of it, not
 // only the swap's output. A V4 SETTLE can take more of the user's tokens than