Merge remote-tracking branch 'origin/main' into nicka/talos-pricing

Author: naddison36

docs/ACTIONS.md

@@ -17,8 +17,9 @@ The mainnet `setPrices*` actions use `--amount` as an explicit override for the
 DEX swap amount when fetching the reference price quote. This is separate from `--buy-amount` and
 `--sell-amount`, which set the buy-side liquidity-asset and sell-side base-asset
 liquidity remaining on the Ethena, USDC, and WETH ARMs. If omitted, each limit is
-set to the maximum `uint128` value. Liquidity amounts are integer native token
-units (for example, `100000000` is 100 tokens for an asset with 6 decimals).
+set to the maximum `uint128` value. Liquidity amounts are token-denominated:
+`1` is one liquidity or base token, with the appropriate token decimals applied
+by the action.
 When `--amount` is omitted, the DEX quote amount is the smaller of the
 withdrawable ARM/market reserves and the corresponding price liquidity limit.
 An explicit `--amount` is used unchanged.

src/js/tasks/actions/autoClaimLidoWithdraw.ts

@@ -13,12 +13,19 @@ action({
   description: "Claim Lido withdrawals from Lido ARM",
   chains: [1],
   params: (t) =>
-    t.addOptionalParam(
-      "id",
-      "Specific Lido withdrawal request identifier to claim. (default: all)",
-      undefined,
-      types.string,
-    ),
+    t
+      .addOptionalParam(
+        "id",
+        "Specific Lido withdrawal request identifier to claim. (deprecated: use ids)",
+        undefined,
+        types.string,
+      )
+      .addOptionalParam(
+        "ids",
+        "Comma-separated Lido withdrawal request identifiers to claim. (default: all)",
+        undefined,
+        types.string,
+      ),
   run: async ({ signer, log, args }) => {
     const arm = new ethers.Contract(mainnet.lidoARM, lidoARMAbi, signer);
     const withdrawalQueue = new ethers.Contract(
@@ -38,6 +45,7 @@ action({
         armName: "Lido",
         withdrawalQueue,
         id: args.id,
+        ids: args.ids,
       },
     });
   },

src/js/tasks/actions/autoClaimWETHEtherFiWithdraw.ts

@@ -12,12 +12,19 @@ action({
   description: "Claim EtherFi withdrawals from WETH ARM",
   chains: [1],
   params: (t) =>
-    t.addOptionalParam(
-      "id",
-      "Specific EtherFi withdrawal request identifier to claim. (default: all)",
-      undefined,
-      types.string,
-    ),
+    t
+      .addOptionalParam(
+        "id",
+        "Specific EtherFi withdrawal request identifier to claim. (deprecated: use ids)",
+        undefined,
+        types.string,
+      )
+      .addOptionalParam(
+        "ids",
+        "Comma-separated EtherFi withdrawal request identifiers to claim. (default: all)",
+        undefined,
+        types.string,
+      ),
   run: async ({ signer, log, args }) => {
     const arm = new ethers.Contract(mainnet.wethARM, multiAssetARMAbi, signer);
 
@@ -31,6 +38,7 @@ action({
         arm,
         armName: "WETH",
         id: args.id,
+        ids: args.ids,
       },
     });
   },

src/js/tasks/actions/autoClaimWETHLidoWithdraw.ts

@@ -12,12 +12,19 @@ action({
   description: "Claim Lido withdrawals from WETH ARM",
   chains: [1],
   params: (t) =>
-    t.addOptionalParam(
-      "id",
-      "Specific Lido withdrawal request identifier to claim. (default: all)",
-      undefined,
-      types.string,
-    ),
+    t
+      .addOptionalParam(
+        "id",
+        "Specific Lido withdrawal request identifier to claim. (deprecated: use ids)",
+        undefined,
+        types.string,
+      )
+      .addOptionalParam(
+        "ids",
+        "Comma-separated Lido withdrawal request identifiers to claim. (default: all)",
+        undefined,
+        types.string,
+      ),
   run: async ({ signer, log, args }) => {
     const arm = new ethers.Contract(mainnet.wethARM, multiAssetARMAbi, signer);
 
@@ -31,6 +38,7 @@ action({
         arm,
         armName: "WETH",
         id: args.id,
+        ids: args.ids,
       },
     });
   },

src/js/tasks/actions/setPricesEthena.ts

@@ -31,15 +31,15 @@ action({
       )
       .addOptionalParam(
         "buyAmount",
-        "Liquidity asset amount remaining at the buy price for multi-base ARMs, as an integer in native token units.",
+        "USDe remaining at the buy price, in token units (1 = 1 USDe).",
         undefined,
-        types.string,
+        types.float,
       )
       .addOptionalParam(
         "sellAmount",
-        "Base asset amount remaining at the sell price for multi-base ARMs, as an integer in native token units.",
+        "sUSDe remaining at the sell price, in token units (1 = 1 sUSDe).",
         undefined,
-        types.string,
+        types.float,
       )
       .addOptionalParam(
         "maxBuyPrice",

src/js/tasks/actions/setPricesUSDC.ts

@@ -35,15 +35,15 @@ action({
       )
       .addOptionalParam(
         "buyAmount",
-        "Liquidity asset amount remaining at the buy price for multi-base ARMs, as an integer in native token units.",
+        "USDC remaining at the buy price, in token units (1 = 1 USDC).",
         undefined,
-        types.string,
+        types.float,
       )
       .addOptionalParam(
         "sellAmount",
-        "Base asset amount remaining at the sell price for multi-base ARMs, as an integer in native token units.",
+        "Base asset remaining at the sell price, in token units (1 = 1 token).",
         undefined,
-        types.string,
+        types.float,
       )
       .addOptionalParam(
         "maxBuyPrice",

src/js/tasks/actions/setPricesWETH.ts

@@ -56,15 +56,15 @@ action({
       )
       .addOptionalParam(
         "buyAmount",
-        "WETH remaining at the buy price, as an integer in native token units.",
+        "WETH remaining at the buy price, in token units (1 = 1 WETH).",
         undefined,
-        types.string,
+        types.float,
       )
       .addOptionalParam(
         "sellAmount",
-        "Base asset remaining at the sell price, as an integer in native token units.",
+        "Base asset remaining at the sell price, in token units (1 = 1 token).",
         undefined,
-        types.string,
+        types.float,
       )
       .addOptionalParam(
         "maxBuyPrice",

src/js/tasks/armPrices.js

@@ -91,6 +91,13 @@ const setPrices = async (options) => {
   // Base asset decimals used to scale aggregator quote amounts. Legacy ARM
   // configs don't expose baseAssetDecimals as all their assets are 18 decimals.
   const baseDecimals = Number(config.baseAssetDecimals ?? 18);
+  const liquidityDecimals = Number(
+    await new Contract(
+      liquidityAddress,
+      ["function decimals() view returns (uint8)"],
+      signer,
+    ).decimals(),
+  );
 
   log(`Getting current ARM prices:`);
   log(`base asset         : ${baseSymbol}`);
@@ -114,17 +121,6 @@ const setPrices = async (options) => {
         ? 10n
         : 30n;
 
-    // The liquidity asset decimals are not in the base asset config so read
-    // them on-chain. Can differ from the base asset decimals, eg an 18
-    // decimals base asset over a 6 decimals USDC liquidity asset.
-    const liquidityDecimals = Number(
-      await new Contract(
-        liquidityAddress,
-        ["function decimals() view returns (uint8)"],
-        signer,
-      ).decimals(),
-    );
-
     // 2.1 Get reference prices
     let referencePrices;
     if (midPrice) {
@@ -152,8 +148,8 @@ const setPrices = async (options) => {
         amount: options.amount,
         liquidityAssets: reserves?.liquidityAssets ?? reserves?.[0],
         baseAssetReserve: reserves?.baseAssetReserve ?? reserves?.[1],
-        buyLiquidity: parseSwapCap(buyAmount),
-        sellLiquidity: parseSwapCap(sellAmount),
+        buyLiquidity: parseSwapCap(buyAmount, liquidityDecimals),
+        sellLiquidity: parseSwapCap(sellAmount, baseDecimals),
         liquidityDecimals,
         baseDecimals,
       });
@@ -392,8 +388,8 @@ const setPrices = async (options) => {
   const toleranceScaled = parseUnits(tolerance.toString(), 36 - 4);
   log(`tolerance          : ${formatUnits(toleranceScaled, 32)} basis points`);
 
-  const targetBuyAmount = parseSwapCap(buyAmount);
-  const targetSellAmount = parseSwapCap(sellAmount);
+  const targetBuyAmount = parseSwapCap(buyAmount, liquidityDecimals);
+  const targetSellAmount = parseSwapCap(sellAmount, baseDecimals);
   const swapCapsChanged = haveSwapCapsChanged(
     baseContext,
     targetBuyAmount,

src/js/tasks/etherfiQueue.js

@@ -10,6 +10,7 @@ const {
 } = require("../utils/arm");
 const addresses = require("../utils/addresses");
 const { createApolloClient } = require("../utils/apollo");
+const { parseRequestIds } = require("../utils/requestIds");
 const { logTxDetails } = require("../utils/txLogger");
 
 const log = require("../utils/logger")("task:etherfiQueue");
@@ -42,12 +43,13 @@ const requestEtherFiWithdrawals = async (options) => {
 };
 
 const claimEtherFiWithdrawals = async (options) => {
-  const { signer, id } = options;
+  const { signer } = options;
   const baseContext = await resolveArmBase(options);
 
-  const requestIds = id
-    ? // If an id is provided, just claim that one
-      [id]
+  const selectedRequestIds = parseRequestIds(options);
+  const requestIds = selectedRequestIds
+    ? // If ids are provided, claim exactly those requests.
+      selectedRequestIds
     : // Get the outstanding EtherFi withdrawal requests for the ARM
       await claimableEtherFiRequests(signer);
 

src/js/tasks/lidoQueue.js

@@ -7,6 +7,7 @@ const {
   requestBaseAssetWithdrawal,
   resolveArmBase,
 } = require("../utils/arm");
+const { parseRequestIds } = require("../utils/requestIds");
 const { logTxDetails } = require("../utils/txLogger");
 
 const log = require("../utils/logger")("task:lidoQueue");
@@ -83,18 +84,19 @@ const requestLidoWithdrawals = async (options) => {
 };
 
 const claimLidoWithdrawals = async (options) => {
-  const { signer, id, withdrawalQueue } = options;
+  const { signer, withdrawalQueue } = options;
   const baseContext = await resolveArmBase(options);
   const { config } = baseContext;
+  const selectedRequestIds = parseRequestIds(options);
 
   if (baseContext.version === "legacy") {
     if (!withdrawalQueue) {
       throw new Error("Legacy Lido claims require the Lido withdrawal queue");
     }
 
     const finalizedIds = [];
-    if (id) {
-      finalizedIds.push(id);
+    if (selectedRequestIds) {
+      finalizedIds.push(...selectedRequestIds);
     } else {
       const requestIds = await withdrawalQueue.getWithdrawalRequests(
         await baseContext.arm.getAddress(),
@@ -150,11 +152,21 @@ const claimLidoWithdrawals = async (options) => {
   const adapter = await adapterContract(config.adapter, signer);
 
   let shares;
-  if (id) {
-    shares = await adapter["requestShares(uint256)"](id);
+  if (selectedRequestIds) {
+    shares = 0n;
+    for (const requestId of selectedRequestIds) {
+      const requestShares = await adapter["requestShares(uint256)"](requestId);
+      if (requestShares === 0n) {
+        log(
+          `Withdrawal request ${requestId} does not belong to the ${baseContext.baseSymbol} adapter`,
+        );
+        continue;
+      }
+      shares += requestShares;
+    }
     if (shares === 0n) {
       log(
-        `Withdrawal request ${id} does not belong to the ${baseContext.baseSymbol} adapter`,
+        `No selected withdrawal requests belong to the ${baseContext.baseSymbol} adapter`,
       );
       return;
     }