fix: a split swap's Min. received is the sum of its steps' minimums (closes #647)
The step that sets the output side gives the minimum. When that step and earlier swap steps each pay the output token to the sender, the minimum is now the sum of their minimums. There is no figure when the decoder reads none from one of them, or when one of them pays part of that token elsewhere. These steps drop earlier steps from the sum: - a V2 or V3 swap step that spends the output token; - a V4 step with a swap action that spends that token, or with a SETTLE or SETTLE_ALL of that token; - a PERMIT2_TRANSFER_FROM of that token. A step after the step that sets the output side drops nothing from the sum. Model: opus-5-5
This commit is contained in:
+352
-2
@@ -2871,8 +2871,9 @@ describe("uniswap decoder", () => {
|
||||
...USDT_400_GROUP,
|
||||
...ONE_USDT_LINES(OTHER_ADDR),
|
||||
],
|
||||
// The last swap step's minimum.
|
||||
minimum: "390.0000 USDC",
|
||||
// Both swap steps pay USDC to the user, so the minimum
|
||||
// is the sum of their two minimums.
|
||||
minimum: "980.0000 USDC",
|
||||
},
|
||||
])(
|
||||
"$kind shows each take's own lines and the allowances, and no Amount figure or Min. received",
|
||||
@@ -3638,6 +3639,355 @@ describe("uniswap decoder", () => {
|
||||
]);
|
||||
});
|
||||
});
|
||||
|
||||
// https://git.eeqj.de/sneak/AutistMask/issues/647 — on next at
|
||||
// f550d8c, a split whose steps each pay WETH to the user showed only
|
||||
// the last step's minimum.
|
||||
describe("the minimum of a split that pays WETH to the user", () => {
|
||||
const WETH_01 = 100000000000000000n;
|
||||
const WETH_02 = 200000000000000000n;
|
||||
const WETH_03 = 300000000000000000n;
|
||||
// A V3 exact-in of 600 USDT for at least 0.3 WETH, and a V2
|
||||
// exact-in of 400 USDT for at least 0.2 WETH, each paid to the
|
||||
// user.
|
||||
const V3_TO_WETH = encodeV3SwapExactIn(
|
||||
USER_ADDR,
|
||||
USDT_600,
|
||||
WETH_03,
|
||||
[USDT_ADDR, WETH_ADDR],
|
||||
);
|
||||
const V2_TO_WETH = encodeV2SwapExactIn(
|
||||
USER_ADDR,
|
||||
USDT_400,
|
||||
WETH_02,
|
||||
[USDT_ADDR, WETH_ADDR],
|
||||
);
|
||||
// A V4 step that swaps 400 USDT for at least 0.2 WETH, with these
|
||||
// TAKEs of the WETH.
|
||||
const v4ToWeth = (...takes) =>
|
||||
encodeV4Swap(
|
||||
new Uint8Array([
|
||||
V4_SWAP_EXACT_IN_SINGLE_ID,
|
||||
V4_SETTLE_ID,
|
||||
...takes.map(() => V4_TAKE_ID),
|
||||
]),
|
||||
[
|
||||
encodeV4ExactInSingle(
|
||||
USDT_ADDR,
|
||||
WETH_ADDR,
|
||||
USDT_400,
|
||||
WETH_02,
|
||||
),
|
||||
encodeV4Settle(USDT_ADDR), // paid by the user
|
||||
...takes,
|
||||
],
|
||||
);
|
||||
// The swap's minimum line as [label, value], or undefined.
|
||||
const minimum = (result) =>
|
||||
result.details
|
||||
.filter(
|
||||
(d) =>
|
||||
d.label === "Min. received" ||
|
||||
d.label === "Min. paid out",
|
||||
)
|
||||
.map((d) => [d.label, d.value])[0];
|
||||
|
||||
test("a V3 and a V2 exact-in show the total of their minimums", () => {
|
||||
const result = decodeSteps(
|
||||
[0x00, 0x08],
|
||||
[V3_TO_WETH, V2_TO_WETH],
|
||||
);
|
||||
expect(minimum(result)).toEqual([
|
||||
"Min. received",
|
||||
"0.5000 WETH",
|
||||
]);
|
||||
});
|
||||
|
||||
test("a V3 exact-in and a V4 step show the total of their minimums", () => {
|
||||
const result = decodeSteps(
|
||||
[0x00, 0x10],
|
||||
[V3_TO_WETH, v4ToWeth(encodeV4Take(WETH_ADDR))],
|
||||
);
|
||||
expect(minimum(result)).toEqual([
|
||||
"Min. received",
|
||||
"0.5000 WETH",
|
||||
]);
|
||||
});
|
||||
|
||||
// The second route buys DAI for the router, then swaps all of it
|
||||
// from the router for at least 0.2 WETH.
|
||||
test("a route that hops through DAI counts its last hop's minimum", () => {
|
||||
const result = decodeSteps(
|
||||
[0x00, 0x08, 0x00],
|
||||
[
|
||||
V3_TO_WETH,
|
||||
encodeV2SwapExactIn(ROUTER_ADDR, USDT_400, DAI_400, [
|
||||
USDT_ADDR,
|
||||
DAI_ADDR,
|
||||
]),
|
||||
coder.encode(
|
||||
["address", "uint256", "uint256", "bytes", "bool"],
|
||||
[
|
||||
USER_ADDR,
|
||||
2n ** 255n, // CONTRACT_BALANCE
|
||||
WETH_02,
|
||||
encodeV3Path([DAI_ADDR, WETH_ADDR]),
|
||||
false, // paid from the router
|
||||
],
|
||||
),
|
||||
],
|
||||
);
|
||||
expect(minimum(result)).toEqual([
|
||||
"Min. received",
|
||||
"0.5000 WETH",
|
||||
]);
|
||||
});
|
||||
|
||||
// The middle step swaps 0.3 of the user's WETH for USDC, so the
|
||||
// sum of minimums starts again after it.
|
||||
test.each([
|
||||
{
|
||||
kind: "a V3 exact-in",
|
||||
command: 0x00,
|
||||
input: encodeV3SwapExactIn(USER_ADDR, WETH_03, 1n, [
|
||||
WETH_ADDR,
|
||||
USDC_ADDR,
|
||||
]),
|
||||
},
|
||||
{
|
||||
kind: "a V2 exact-in",
|
||||
command: 0x08,
|
||||
input: encodeV2SwapExactIn(USER_ADDR, WETH_03, 1n, [
|
||||
WETH_ADDR,
|
||||
USDC_ADDR,
|
||||
]),
|
||||
},
|
||||
{
|
||||
kind: "a V2 exact-out",
|
||||
command: 0x09,
|
||||
input: encodeV2SwapExactOut(USER_ADDR, 1n, WETH_03, [
|
||||
WETH_ADDR,
|
||||
USDC_ADDR,
|
||||
]),
|
||||
},
|
||||
{
|
||||
kind: "a V3 exact-out",
|
||||
command: 0x01,
|
||||
input: encodeV3SwapExactOut(USER_ADDR, 1n, WETH_03, [
|
||||
USDC_ADDR,
|
||||
WETH_ADDR,
|
||||
]),
|
||||
},
|
||||
])(
|
||||
"$kind that spends WETH between them leaves the last step's minimum",
|
||||
({ command, input }) => {
|
||||
const result = decodeSteps(
|
||||
[0x00, command, 0x08],
|
||||
[V3_TO_WETH, input, V2_TO_WETH],
|
||||
);
|
||||
expect(minimum(result)).toEqual([
|
||||
"Min. received",
|
||||
"0.2000 WETH",
|
||||
]);
|
||||
},
|
||||
);
|
||||
|
||||
// The middle step swaps 0.3 WETH and 400 DAI for USDC, both paid
|
||||
// by the user. It spends WETH whichever SETTLE comes last.
|
||||
test.each([
|
||||
{ order: "WETH first", settled: [WETH_ADDR, DAI_ADDR] },
|
||||
{ order: "DAI first", settled: [DAI_ADDR, WETH_ADDR] },
|
||||
])(
|
||||
"a V4 step that spends WETH and DAI between them leaves the last step's minimum, with the SETTLE of $order",
|
||||
({ settled }) => {
|
||||
const wethAndDaiForUsdc = encodeV4Swap(
|
||||
new Uint8Array([
|
||||
V4_SWAP_EXACT_IN_SINGLE_ID,
|
||||
V4_SWAP_EXACT_IN_SINGLE_ID,
|
||||
V4_SETTLE_ID,
|
||||
V4_SETTLE_ID,
|
||||
V4_TAKE_ALL_ID,
|
||||
]),
|
||||
[
|
||||
encodeV4ExactInSingle(
|
||||
WETH_ADDR,
|
||||
USDC_ADDR,
|
||||
WETH_03,
|
||||
1n,
|
||||
),
|
||||
encodeV4ExactInSingle(
|
||||
DAI_ADDR,
|
||||
USDC_ADDR,
|
||||
DAI_400,
|
||||
1n,
|
||||
),
|
||||
...settled.map((token) => encodeV4Settle(token)),
|
||||
encodeV4TakeAll(USDC_ADDR, 0n),
|
||||
],
|
||||
);
|
||||
const result = decodeSteps(
|
||||
[0x00, 0x10, 0x08],
|
||||
[V3_TO_WETH, wethAndDaiForUsdc, V2_TO_WETH],
|
||||
);
|
||||
expect(minimum(result)).toEqual([
|
||||
"Min. received",
|
||||
"0.2000 WETH",
|
||||
]);
|
||||
},
|
||||
);
|
||||
|
||||
// The middle step's swap actions buy WETH with the user's USDT,
|
||||
// then swap all of that WETH for USDC.
|
||||
test("a V4 step that swaps through WETH between them leaves the last step's minimum", () => {
|
||||
const usdtToUsdcThroughWeth = encodeV4Swap(
|
||||
new Uint8Array([
|
||||
V4_SWAP_EXACT_IN_SINGLE_ID,
|
||||
V4_SWAP_EXACT_IN_SINGLE_ID,
|
||||
V4_SETTLE_ID,
|
||||
V4_TAKE_ALL_ID,
|
||||
]),
|
||||
[
|
||||
encodeV4ExactInSingle(
|
||||
USDT_ADDR,
|
||||
WETH_ADDR,
|
||||
USDT_400,
|
||||
WETH_01,
|
||||
),
|
||||
encodeV4ExactInSingle(WETH_ADDR, USDC_ADDR, 0n, 1n),
|
||||
encodeV4Settle(USDT_ADDR), // paid by the user
|
||||
encodeV4TakeAll(USDC_ADDR, 0n),
|
||||
],
|
||||
);
|
||||
const result = decodeSteps(
|
||||
[0x00, 0x10, 0x08],
|
||||
[V3_TO_WETH, usdtToUsdcThroughWeth, V2_TO_WETH],
|
||||
);
|
||||
expect(minimum(result)).toEqual([
|
||||
"Min. received",
|
||||
"0.2000 WETH",
|
||||
]);
|
||||
});
|
||||
|
||||
// The middle step has no swap action. Its SETTLE or SETTLE_ALL
|
||||
// pays 0.3 WETH, and its TAKE pays that WETH to another address.
|
||||
test.each([
|
||||
{
|
||||
payment: "a SETTLE of WETH paid by the user",
|
||||
actions: [V4_SETTLE_ID, V4_TAKE_ID],
|
||||
params: [
|
||||
settle(WETH_ADDR, WETH_03, true),
|
||||
take(WETH_ADDR, OTHER_ADDR, 0n),
|
||||
],
|
||||
},
|
||||
{
|
||||
payment: "a SETTLE of WETH paid from the router",
|
||||
actions: [V4_SETTLE_ID, V4_TAKE_ID],
|
||||
params: [
|
||||
settle(WETH_ADDR, WETH_03, false),
|
||||
take(WETH_ADDR, OTHER_ADDR, 0n),
|
||||
],
|
||||
},
|
||||
{
|
||||
payment: "a SETTLE_ALL of WETH",
|
||||
actions: [V4_TAKE_ID, V4_SETTLE_ALL_ID],
|
||||
params: [
|
||||
take(WETH_ADDR, OTHER_ADDR, WETH_03),
|
||||
encodeV4SettleAll(WETH_ADDR, WETH_03),
|
||||
],
|
||||
},
|
||||
])(
|
||||
"a V4 step with $payment between them leaves the last step's minimum",
|
||||
({ actions, params }) => {
|
||||
const wethToOther = encodeV4Swap(
|
||||
new Uint8Array(actions),
|
||||
params,
|
||||
);
|
||||
const result = decodeSteps(
|
||||
[0x00, 0x10, 0x08],
|
||||
[V3_TO_WETH, wethToOther, V2_TO_WETH],
|
||||
);
|
||||
expect(minimum(result)).toEqual([
|
||||
"Min. paid out",
|
||||
"0.2000 WETH",
|
||||
]);
|
||||
},
|
||||
);
|
||||
|
||||
test("a PERMIT2_TRANSFER_FROM of WETH between them leaves the last step's minimum", () => {
|
||||
const result = decodeSteps(
|
||||
[0x00, 0x02, 0x08],
|
||||
[
|
||||
V3_TO_WETH,
|
||||
permit2TransferFrom(WETH_ADDR, OTHER_ADDR, WETH_03),
|
||||
V2_TO_WETH,
|
||||
],
|
||||
);
|
||||
expect(minimum(result)).toEqual([
|
||||
"Min. paid out",
|
||||
"0.2000 WETH",
|
||||
]);
|
||||
});
|
||||
|
||||
// The decoder reads no minimum from a V4 exact-out action.
|
||||
test("a step that states no minimum leaves no figure", () => {
|
||||
const exactOut = encodeV4Swap(
|
||||
new Uint8Array([
|
||||
V4_SWAP_EXACT_OUT_SINGLE_ID,
|
||||
V4_SETTLE_ALL_ID,
|
||||
V4_TAKE_ALL_ID,
|
||||
]),
|
||||
[
|
||||
encodeV4ExactOutSingle(
|
||||
USDT_ADDR,
|
||||
WETH_ADDR,
|
||||
WETH_02,
|
||||
USDT_400,
|
||||
),
|
||||
encodeV4SettleAll(USDT_ADDR, USDT_400),
|
||||
encodeV4TakeAll(WETH_ADDR, 0n),
|
||||
],
|
||||
);
|
||||
const result = decodeSteps(
|
||||
[0x10, 0x00],
|
||||
[exactOut, V3_TO_WETH],
|
||||
);
|
||||
expect(minimum(result)).toBeUndefined();
|
||||
});
|
||||
|
||||
test("a step that pays some of its WETH to the router leaves no figure", () => {
|
||||
const result = decodeSteps(
|
||||
[0x00, 0x10],
|
||||
[
|
||||
V3_TO_WETH,
|
||||
v4ToWeth(
|
||||
take(WETH_ADDR, USER_ADDR, WETH_01),
|
||||
take(WETH_ADDR, ROUTER_ADDR, 0n),
|
||||
),
|
||||
],
|
||||
);
|
||||
expect(minimum(result)).toBeUndefined();
|
||||
});
|
||||
|
||||
// The router still runs a swap step whose recipient cannot be
|
||||
// read, and that step may spend the WETH the first step paid.
|
||||
test("a step between them that cannot be read leaves no figure", () => {
|
||||
const result = decodeSteps(
|
||||
[0x00, 0x00, 0x08],
|
||||
[
|
||||
V3_TO_WETH,
|
||||
dirtyWord(
|
||||
encodeV3SwapExactIn(USER_ADDR, WETH_03, 1n, [
|
||||
WETH_ADDR,
|
||||
USDC_ADDR,
|
||||
]),
|
||||
0,
|
||||
),
|
||||
V2_TO_WETH,
|
||||
],
|
||||
);
|
||||
expect(minimum(result)).toBeUndefined();
|
||||
});
|
||||
});
|
||||
});
|
||||
|
||||
// https://git.eeqj.de/sneak/AutistMask/issues/359 — the output half, in
|
||||
|
||||
Reference in New Issue
Block a user