ci: validate vault and reserve metrics data

.github/workflows/vaults-and-reserve-metrics-testing.yml

@@ -0,0 +1,100 @@
+name: Vaults and Reserve Indexing
+on:
+  pull_request:
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Start A3P container
+        run: docker compose --profile ci up -d a3p
+
+      - run: corepack enable
+        shell: bash
+
+      - name: Setup Node.js environment
+        uses: actions/setup-node@v4
+        with:
+          node-version: 18
+          cache: yarn
+
+      - name: Install dependencies
+        run: yarn install
+
+      - name: Start subql indexer
+        env:
+          AGORIC_NET: ci
+        run: yarn dev
+
+      - name: Print initial logs of all containers
+        run: |
+          echo "Fetching initial logs for all containers..."
+          containers=$(docker ps --format '{{.ID}}')
+          for container in $containers; do
+            echo "Fetching initial logs for container $container..."
+            docker logs $container
+          done
+
+      - name: Set Execute Permission for All Scripts
+        run: chmod +x ./scripts/*.mjs
+
+      - name: Wait for GraphQL server
+        run: sleep 60
+
+      - name: Test Vaults
+        run: ./scripts/validateData.mjs
+        env:
+          entity: vaults
+          blockHeight: 742
+          apiUrl: 'http://localhost:3000/'
+
+      - name: Test VaultStatesDailies
+        run: ./scripts/validateData.mjs
+        env:
+          entity: vaultStatesDailies
+          blockHeight: 742
+          apiUrl: 'http://localhost:3000/'
+
+      - name: Test VaultManagerGovernance
+        run: ./scripts/validateData.mjs
+        env:
+          entity: vaultManagerGovernances
+          blockHeight: 1212
+          apiUrl: 'http://localhost:3000/'
+
+      - name: Test VaultManagerMetrics
+        run: ./scripts/validateData.mjs
+        env:
+          entity: vaultManagerMetrics
+          blockHeight: 1212
+          apiUrl: 'http://localhost:3000/'
+
+      - name: Test VaultManagerMetricsDaily
+        run: ./scripts/validateData.mjs
+        env:
+          entity: vaultManagerMetricsDailies
+          blockHeight: 1212
+          apiUrl: 'http://localhost:3000/'
+
+      - name: Test ReserveMetrics
+        run: ./scripts/validateData.mjs
+        env:
+          entity: reserveMetrics
+          blockHeight: 1212
+          apiUrl: 'http://localhost:3000/'
+
+      - name: Test ReserveAllocationMetrics
+        run: ./scripts/validateData.mjs
+        env:
+          entity: reserveAllocationMetrics
+          blockHeight: 1212
+          apiUrl: 'http://localhost:3000/'
+
+      - name: Test ReserveAllocationMetricsDaily
+        run: ./scripts/validateData.mjs
+        env:
+          entity: reserveAllocationMetricsDailies
+          blockHeight: 1212
+          apiUrl: 'http://localhost:3000/'

scripts/changePrice.mjs

@@ -20,4 +20,5 @@ try {
   console.log('Standard output:', stdout);
 } catch (error) {
   console.error('Error:', error);
+  process.exit(1);
 }

scripts/checkLiquidation.mjs

@@ -118,4 +118,5 @@ try {
   console.log('Validation successful for liquidated vaults.');
 } catch (error) {
   console.error('Validation failed:', error);
+  process.exit(1);
 }

scripts/queries.mjs

@@ -0,0 +1,223 @@
+const buildFilter = (filters) => {
+  const filterStrings = Object.entries(filters).map(([key, value]) => {
+    return `${key}: {equalTo: "${value}"}`;
+  });
+  return `(filter: {${filterStrings.join(', ')}})`;
+};
+
+export const getQuery = (entity, filters) => {
+  const filterString = buildFilter(filters);
+
+  const queries = {
+    vaults: `query {
+        vaults ${filterString} {
+            nodes {
+              balance
+              lockedValue
+              coin
+              denom
+              debt
+              state
+            }
+        }
+    }`,
+    vaultStatesDailies: `query {
+      vaultStatesDailies ${filterString} {
+          nodes {
+              active
+              closed
+              liquidating
+              liquidated
+            }
+          }
+      }`,
+    vaultManagerGovernances: `query {
+          vaultManagerGovernances ${filterString} {
+              nodes {
+                id
+                debtLimit
+                interestRateDenominator
+                interestRateNumerator
+                liquidationMarginDenominator
+                liquidationMarginNumerator
+                liquidationPaddingDenominator
+                liquidationPaddingNumerator
+                liquidationPenaltyDenominator
+                liquidationPenaltyNumerator
+                mintFeeDenominator
+                mintFeeNumerator
+              }
+          }
+      }`,
+    vaultManagerMetrics: `query {
+          vaultManagerMetrics ${filterString} {
+              nodes {
+                id
+                liquidatingCollateralBrand
+                liquidatingCollateralValue
+                liquidatingDebtBrand
+                liquidatingDebtValue
+                lockedQuoteDenominator
+                lockedQuoteNumerator
+                numActiveVaults
+                numLiquidatingVaults
+                numLiquidationsAborted
+                numLiquidationsCompleted
+                retainedCollateral
+                totalCollateral
+                totalCollateralSold
+                totalDebt
+                totalOverageReceived
+                totalProceedsReceived
+                totalShortfallReceived
+              }
+          }
+      }`,
+    vaultManagerMetricsDailies: `query {
+          vaultManagerMetricsDailies ${filterString} {
+              nodes {
+                path
+                liquidatingCollateralBrand
+                liquidatingDebtBrand
+                liquidatingCollateralValueLast
+                liquidatingDebtValueLast
+                lockedQuoteDenominatorLast
+                lockedQuoteNumeratorLast
+                numActiveVaultsLast
+                numLiquidatingVaultsLast
+                numLiquidationsAbortedLast
+                numLiquidationsCompletedLast
+                retainedCollateralLast
+                totalCollateralLast
+                totalCollateralSoldLast
+                totalDebtLast
+                totalOverageReceivedLast
+                totalProceedsReceivedLast
+                totalShortfallReceivedLast
+                metricsCount
+              }
+          }
+      }`,
+    reserveMetrics: `query {
+          reserveMetrics ${filterString} {
+              nodes {
+                id
+                shortfallBalance
+                totalFeeBurned
+                totalFeeMinted
+              }
+          }
+      }`,
+    reserveAllocationMetrics: `query {
+          reserveAllocationMetrics ${filterString} {
+              nodes {
+                id
+                denom
+                key
+                value
+              }
+          }
+      }`,
+    reserveAllocationMetricsDailies: `query {
+          reserveAllocationMetricsDailies ${filterString} {
+              nodes {
+                denom
+                key
+                valueLast
+                metricsCount
+              }
+          }
+      }`,
+  };
+
+  return queries[entity];
+};
+
+export const expectations = {
+  vaults: {
+    balance: '788000000',
+    lockedValue: '788000000',
+    coin: 'ATOM',
+    denom: 'ATOM',
+    debt: '4745610000',
+    state: 'active',
+  },
+  vaultStatesDailies: {
+    active: '1',
+    closed: '0',
+    liquidating: '0',
+    liquidated: '0',
+  },
+  vaultManagerGovernances: {
+    id: 'published.vaultFactory.managers.manager1.governance',
+    debtLimit: '1000000000',
+    interestRateDenominator: '100',
+    interestRateNumerator: '1',
+    liquidationMarginDenominator: '100',
+    liquidationMarginNumerator: '150',
+    liquidationPaddingDenominator: '100',
+    liquidationPaddingNumerator: '25',
+    liquidationPenaltyDenominator: '100',
+    liquidationPenaltyNumerator: '1',
+    mintFeeDenominator: '10000',
+    mintFeeNumerator: '50',
+  },
+  vaultManagerMetrics: {
+    liquidatingCollateralBrand: 'stATOM',
+    liquidatingCollateralValue: '0',
+    liquidatingDebtBrand: 'IST',
+    liquidatingDebtValue: '0',
+    lockedQuoteDenominator: '0',
+    lockedQuoteNumerator: '0',
+    numActiveVaults: '0',
+    numLiquidatingVaults: '0',
+    numLiquidationsAborted: '0',
+    numLiquidationsCompleted: '0',
+    retainedCollateral: '0',
+    totalCollateral: '0',
+    totalCollateralSold: '0',
+    totalDebt: '0',
+    totalOverageReceived: '0',
+    totalProceedsReceived: '0',
+    totalShortfallReceived: '0',
+  },
+  vaultManagerMetricsDailies: {
+    path: 'published.vaultFactory.managers.manager1.metrics',
+    liquidatingCollateralBrand: 'stATOM',
+    liquidatingDebtBrand: 'IST',
+    liquidatingCollateralValueLast: '0',
+    liquidatingDebtValueLast: '0',
+    lockedQuoteDenominatorLast: '0',
+    lockedQuoteNumeratorLast: '0',
+    numActiveVaultsLast: '0',
+    numLiquidatingVaultsLast: '0',
+    numLiquidationsAbortedLast: '0',
+    numLiquidationsCompletedLast: '0',
+    retainedCollateralLast: '0',
+    totalCollateralLast: '0',
+    totalCollateralSoldLast: '0',
+    totalDebtLast: '0',
+    totalOverageReceivedLast: '0',
+    totalProceedsReceivedLast: '0',
+    totalShortfallReceivedLast: '0',
+    metricsCount: '1',
+  },
+  reserveMetrics: {
+    id: 'published.reserve.metrics',
+    shortfallBalance: '0',
+    totalFeeBurned: '0',
+    totalFeeMinted: '0',
+  },
+  reserveAllocationMetrics: {
+    id: 'IST',
+    denom: 'IST',
+    key: 'Fee',
+    value: '187909157',
+  },
+  reserveAllocationMetricsDailies: {
+    denom: 'IST',
+    key: 'Fee',
+    valueLast: '187909157',
+    metricsCount: '1',
+  },
+};

scripts/validateData.mjs

@@ -0,0 +1,42 @@
+#! /usr/bin/env node
+/* eslint-env node */
+import './lockdown.mjs';
+import { equal } from 'node:assert/strict';
+import { getQuery, expectations } from './queries.mjs';
+import { assertAllDefined } from '@agoric/internal';
+
+const apiUrl = process.env.apiUrl || 'https://api.subquery.network/sq/agoric-labs/agoric-mainnet-v2';
+console.log(`API URL set to: ${apiUrl}`);
+
+const { entity, blockHeight } = process.env;
+console.log(`Entity: ${entity}, Block Height: ${blockHeight}`);
+
+assertAllDefined({ entity, blockHeight });
+
+const dailyEntities = ['vaultManagerMetricsDailies', 'reserveAllocationMetricsDailies', 'vaultStatesDailies'];
+const filter = dailyEntities.includes(entity) ? { blockHeightLast: blockHeight } : { blockHeight };
+
+try {
+  const graphqlQuery = { query: getQuery(entity, filter) };
+
+  const response = await fetch(apiUrl, {
+    method: 'POST',
+    headers: {
+      'Content-Type': 'application/json',
+      Accept: 'application/json',
+    },
+    body: JSON.stringify(graphqlQuery),
+  });
+
+  const jsonResponse = await response.json();
+  console.log('Response:', JSON.stringify(jsonResponse));
+  const nodes = jsonResponse?.data[entity]?.nodes;
+  console.log('Node:', nodes);
+
+  for (const key of Object.keys(expectations[entity])) {
+    equal(nodes[0]?.[key], expectations[entity][key]);
+  }
+} catch (error) {
+  console.error('Error:', error);
+  process.exit(1);
+}