Merge pull request #81 from OriginProtocol/v155-outstanding-assets

Add outstandingAssets with in-place backfill migration for v155

Author: apexearth

db/migrations/1781633867200-Data.js

@@ -0,0 +1,26 @@
+module.exports = class Data1781633867200 {
+    name = 'Data1781633867200'
+
+    async up(db) {
+        // In-place upgrade of the live v155 database (continues the existing DB, no re-sync):
+        // add the per-asset `outstanding_assets` array (in-flight protocol redemptions, aligned
+        // to Arm.assets) and backfill it from existing data. Adding a NOT NULL column to a
+        // populated table requires a temporary default; we backfill, then drop the default so the
+        // schema matches main's squashed migration (where the column is created NOT NULL, no default).
+        await db.query(`ALTER TABLE "arm_state" ADD COLUMN "outstanding_assets" text array NOT NULL DEFAULT '{}'`)
+        await db.query(`ALTER TABLE "arm_daily_stat" ADD COLUMN "outstanding_assets" text array NOT NULL DEFAULT '{}'`)
+        // Every ARM is still pre-upgrade (single base asset, upgradeBlock=null), so
+        // outstanding_assets = [0, outstandingAssets1]: [0] = liquidity asset (never redeems into
+        // itself), [1] = the existing outstanding_assets1 scalar. outstanding_assets1 is a numeric
+        // BigInt; cast to plain-integer text to match the entity's decimal-string array format.
+        await db.query(`UPDATE "arm_state" SET "outstanding_assets" = ARRAY['0', "outstanding_assets1"::text]`)
+        await db.query(`UPDATE "arm_daily_stat" SET "outstanding_assets" = ARRAY['0', "outstanding_assets1"::text]`)
+        await db.query(`ALTER TABLE "arm_state" ALTER COLUMN "outstanding_assets" DROP DEFAULT`)
+        await db.query(`ALTER TABLE "arm_daily_stat" ALTER COLUMN "outstanding_assets" DROP DEFAULT`)
+    }
+
+    async down(db) {
+        await db.query(`ALTER TABLE "arm_state" DROP COLUMN "outstanding_assets"`)
+        await db.query(`ALTER TABLE "arm_daily_stat" DROP COLUMN "outstanding_assets"`)
+    }
+}

schema.graphql

@@ -742,6 +742,10 @@ type ArmState @entity {
   # assetTotals[0] = assets0 + outstandingAssets1 + marketAssets (all liquidity-denominated value);
   # assetTotals[i>0] = balanceOf(asset i). assetTotals[i] x assetRates[i] = value in liquidity terms.
   assetTotals: [String!]!
+  # Per-asset protocol redemptions in-flight (adapter withdrawal queues), aligned to Arm.assets.
+  # [0] = liquidity asset (never redeems into itself) = 0; [i>0] = pendingRedeemAssets for base
+  # asset i, liquidity-denominated. Per-asset form of outstandingAssets1 (== sum of [1+]).
+  outstandingAssets: [String!]!
 }
 
 type ArmDailyStat @entity {
@@ -779,6 +783,9 @@ type ArmDailyStat @entity {
   assetTotals: [String!]!
   # asset->liquidity rate, 1e18-scaled (PRICE_SCALE). [0] = 1e18; pegged base = 1e18.
   assetRates: [String!]!
+  # Per-asset protocol redemptions in-flight, aligned to Arm.assets. [0] = 0 (liquidity asset);
+  # [i>0] = liquidity-denominated pendingRedeemAssets for base asset i. == sum is outstandingAssets1.
+  outstandingAssets: [String!]!
 }
 
 type ArmAddressYield @entity {

scripts/generate-validations.ts

@@ -466,6 +466,9 @@ const arm = (prefix: string, armAddress: string) => {
         totalWithdrawals
         totalWithdrawalsClaimed
         totalYield
+        assetBalances
+        assetTotals
+        outstandingAssets
       }
     `),
     gql(`
@@ -523,6 +526,10 @@ const arm = (prefix: string, armAddress: string) => {
         yield
         cumulativeYield
         cumulativeFees
+        assetBalances
+        assetTotals
+        assetRates
+        outstandingAssets
       }
     `),
     gql(`
@@ -559,6 +566,11 @@ const arm = (prefix: string, armAddress: string) => {
         address
         traderate0
         traderate1
+        asset
+        buyPrice
+        sellPrice
+        buyLiquidityRemaining
+        sellLiquidityRemaining
       }
     `),
   ]
@@ -575,6 +587,11 @@ const arms = () => {
       decimals
       token0
       token1
+      assets
+      assetSymbols
+      assetPegged
+      assetAdapters
+      upgradeBlock
     }
   `)
 }

src/model/generated/armDailyStat.model.ts

@@ -103,4 +103,7 @@ export class ArmDailyStat {
 
     @StringColumn_({array: true, nullable: false})
     assetRates!: (string)[]
+
+    @StringColumn_({array: true, nullable: false})
+    outstandingAssets!: (string)[]
 }

src/model/generated/armState.model.ts

@@ -75,4 +75,7 @@ export class ArmState {
 
     @StringColumn_({array: true, nullable: false})
     assetTotals!: (string)[]
+
+    @StringColumn_({array: true, nullable: false})
+    outstandingAssets!: (string)[]
 }

src/templates/origin-arm/origin-arm.graphql

@@ -62,6 +62,10 @@ type ArmState @entity {
   # assetTotals[0] = assets0 + outstandingAssets1 + marketAssets (all liquidity-denominated value);
   # assetTotals[i>0] = balanceOf(asset i). assetTotals[i] x assetRates[i] = value in liquidity terms.
   assetTotals: [String!]!
+  # Per-asset protocol redemptions in-flight (adapter withdrawal queues), aligned to Arm.assets.
+  # [0] = liquidity asset (never redeems into itself) = 0; [i>0] = pendingRedeemAssets for base
+  # asset i, liquidity-denominated. Per-asset form of outstandingAssets1 (== sum of [1+]).
+  outstandingAssets: [String!]!
 }
 
 type ArmDailyStat @entity {
@@ -99,6 +103,9 @@ type ArmDailyStat @entity {
   assetTotals: [String!]!
   # asset->liquidity rate, 1e18-scaled (PRICE_SCALE). [0] = 1e18; pegged base = 1e18.
   assetRates: [String!]!
+  # Per-asset protocol redemptions in-flight, aligned to Arm.assets. [0] = 0 (liquidity asset);
+  # [i>0] = liquidity-denominated pendingRedeemAssets for base asset i. == sum is outstandingAssets1.
+  outstandingAssets: [String!]!
 }
 
 type ArmAddressYield @entity {

src/templates/origin-arm/origin-arm.ts

@@ -305,14 +305,19 @@ export const createOriginARMProcessors = ({
           )
           const assets0 = assetBalancesBig[0] ?? 0n // idle liquidity asset (WETH / USDe)
           const assets1 = assetBalancesBig[1] ?? 0n // legacy primary base asset
-          let outstandingAssets1: bigint
+          // Per-asset protocol redemptions in-flight (adapter withdrawal queues), aligned to
+          // armEntity.assets. [0] = liquidity asset (never redeems into itself) = 0; [i>0] =
+          // liquidity-denominated amount pending for base asset i. Multiple base assets can be
+          // redeeming at once post-upgrade. Legacy scalar outstandingAssets1 == sum of [1+].
+          let outstandingAssetsBig: bigint[]
           if (upgraded) {
             // Post-upgrade: pending protocol redemptions live per base asset in liquidity terms.
             const multibase = new originMultibaseArmAbi.Contract(ctx, block.header, armAddress)
             const configs = await Promise.all(armEntity.assets.slice(1).map((a) => multibase.baseAssetConfigs(a)))
-            outstandingAssets1 = configs.reduce((acc, c) => acc + c.pendingRedeemAssets, 0n)
+            outstandingAssetsBig = [0n, ...configs.map((c) => c.pendingRedeemAssets)]
           } else {
-            outstandingAssets1 = await {
+            // Pre-upgrade: single base asset, one chain-specific withdrawal-queue call.
+            const single = await {
               lido: lidoArmContract.lidoWithdrawalQueueAmount.bind(lidoArmContract),
               os: osArmContract.vaultWithdrawalAmount.bind(osArmContract),
               etherfi: etherfiArmContract.etherfiWithdrawalQueueAmount.bind(etherfiArmContract),
@@ -321,7 +326,9 @@ export const createOriginARMProcessors = ({
                 return await ethenaArmContract.liquidityAmountInCooldown()
               },
             }[armType]()
+            outstandingAssetsBig = [0n, single]
           }
+          const outstandingAssets1 = outstandingAssetsBig.reduce((acc, b) => acc + b, 0n)
           const [feesAccrued, totalAssets, totalAssetsCap, totalSupply, assetsPerShare, activeMarket, claimable] =
             await Promise.all([
               armContract.feesAccrued(),
@@ -376,6 +383,8 @@ export const createOriginARMProcessors = ({
               (assets0 + outstandingAssets1 + marketAssets).toString(),
               ...assetBalancesBig.slice(1).map((b) => b.toString()),
             ],
+            // Per-asset redemptions in-flight, aligned to assets. [0] = 0; sum of [1+] == outstandingAssets1.
+            outstandingAssets: outstandingAssetsBig.map((b) => b.toString()),
           })
           armStateEntity.totalYield = calculateTotalYield(armStateEntity)
           states.push(armStateEntity)
@@ -754,6 +763,7 @@ export const createOriginARMProcessors = ({
               assetBalances: state.assetBalances,
               assetTotals: state.assetTotals,
               assetRates,
+              outstandingAssets: state.outstandingAssets,
             })
             dailyStatsMap.set(currentDayId, armDailyStatEntity)
           }