Treasury-Subgraph Updates (#2978)

* Update treasury-subgraph-client * Add ignoreCache prop to treasury dashboard. Also shift functions to use destructured parameters, due to the presence of multiple optional parameters. * Add retry on metrics endpoint * Add liquid backing/OHM contribution to the treasury assets table. Ensure record values are numbers. * Test fixes
OlympusDAO · Sep 28, 2023 · 842a1b1 · 842a1b1
1 parent f9e4a75
commit 842a1b1
Show file tree

Hide file tree

Showing 20 changed files with 681 additions and 466 deletions.
diff --git a/src/hooks/useFederatedSubgraphQuery.ts b/src/hooks/useFederatedSubgraphQuery.ts
@@ -28,12 +28,21 @@ export const { useQuery: useFederatedSubgraphQuery } = createHooks<Operations>(c
  * @param crossChainDataComplete If true, returns up (and including) the date with complete cross-chain data.
  * @returns
  */
-export const useTokenRecordsQuery = (startDate: string | null | undefined, crossChainDataComplete?: boolean) => {
+export const useTokenRecordsQuery = ({
+  startDate,
+  crossChainDataComplete,
+  ignoreCache,
+}: {
+  startDate: string | null | undefined;
+  crossChainDataComplete?: boolean;
+  ignoreCache?: boolean;
+}) => {
   return useFederatedSubgraphQuery({
     operationName: "paginated/tokenRecords",
     input: {
       startDate: startDate || "",
       crossChainDataComplete: crossChainDataComplete || false,
+      ignoreCache: ignoreCache || false,
     },
     enabled: startDate != null,
   });
@@ -50,8 +59,14 @@ export const useTokenRecordsQuery = (startDate: string | null | undefined, cross
  * @param startDate Date string in YYYY-MM-DD format.
  * @returns TokenRecord[] or undefined if there are no results
  */
-export const useTokenRecordsQueryComplete = (startDate: string | null | undefined): TokenRecord[] | undefined => {
-  const { data: tokenRecordResults } = useTokenRecordsQuery(startDate, true);
+export const useTokenRecordsQueryComplete = ({
+  startDate,
+  ignoreCache,
+}: {
+  startDate: string | null | undefined;
+  ignoreCache?: boolean;
+}): TokenRecord[] | undefined => {
+  const { data: tokenRecordResults } = useTokenRecordsQuery({ startDate, crossChainDataComplete: true, ignoreCache });
   const [untilLatestDateResults, setUntilLatestDateResults] = useState<TokenRecord[]>();
 
   useEffect(() => {
@@ -77,10 +92,14 @@ export const useTokenRecordsQueryComplete = (startDate: string | null | undefine
  * @param startDate
  * @returns TokenRecord[] or undefined if there are no results
  */
-export const useTokenRecordsQueryLatestCompleteData = (
-  startDate: string | null | undefined,
-): TokenRecord[] | undefined => {
-  const tokenRecordResults = useTokenRecordsQueryComplete(startDate);
+export const useTokenRecordsQueryLatestCompleteData = ({
+  startDate,
+  ignoreCache,
+}: {
+  startDate: string | null | undefined;
+  ignoreCache?: boolean;
+}): TokenRecord[] | undefined => {
+  const tokenRecordResults = useTokenRecordsQueryComplete({ startDate, ignoreCache });
   const [latestData, setLatestData] = useState<TokenRecord[]>();
 
   useEffect(() => {
@@ -102,9 +121,12 @@ export const useTokenRecordsQueryLatestCompleteData = (
  *
  * This is useful for determining the latest block that has been indexed.
  */
-export const useTokenRecordsLatestQuery = () => {
+export const useTokenRecordsLatestQuery = ({ ignoreCache }: { ignoreCache?: boolean }) => {
   return useFederatedSubgraphQuery({
     operationName: "latest/tokenRecords",
+    input: {
+      ignoreCache: ignoreCache || false,
+    },
   });
 };
 
@@ -117,12 +139,21 @@ export const useTokenRecordsLatestQuery = () => {
  * @param crossChainDataComplete If true, returns up (and including) the date with complete cross-chain data.
  * @returns
  */
-export const useTokenSuppliesQuery = (startDate: string | null | undefined, crossChainDataComplete?: boolean) => {
+export const useTokenSuppliesQuery = ({
+  startDate,
+  crossChainDataComplete,
+  ignoreCache,
+}: {
+  startDate: string | null | undefined;
+  crossChainDataComplete?: boolean;
+  ignoreCache?: boolean;
+}) => {
   return useFederatedSubgraphQuery({
     operationName: "paginated/tokenSupplies",
     input: {
       startDate: startDate || "",
       crossChainDataComplete: crossChainDataComplete || false,
+      ignoreCache: ignoreCache || false,
     },
     enabled: startDate != null,
   });
@@ -139,8 +170,14 @@ export const useTokenSuppliesQuery = (startDate: string | null | undefined, cros
  * @param startDate Date string in YYYY-MM-DD format.
  * @returns TokenSupply[] or undefined if there are no results
  */
-export const useTokenSuppliesQueryComplete = (startDate: string | null | undefined): TokenSupply[] | undefined => {
-  const { data: tokenSupplyResults } = useTokenSuppliesQuery(startDate, true);
+export const useTokenSuppliesQueryComplete = ({
+  startDate,
+  ignoreCache,
+}: {
+  startDate: string | null | undefined;
+  ignoreCache?: boolean;
+}): TokenSupply[] | undefined => {
+  const { data: tokenSupplyResults } = useTokenSuppliesQuery({ startDate, crossChainDataComplete: true, ignoreCache });
   const [untilLatestDateResults, setUntilLatestDateResults] = useState<TokenSupply[]>();
 
   useEffect(() => {
@@ -166,10 +203,14 @@ export const useTokenSuppliesQueryComplete = (startDate: string | null | undefin
  * @param startDate
  * @returns TokenSupply[] or undefined if there are no results
  */
-export const useTokenSuppliesQueryLatestCompleteData = (
-  startDate: string | null | undefined,
-): TokenSupply[] | undefined => {
-  const tokenSupplyResults = useTokenSuppliesQueryComplete(startDate);
+export const useTokenSuppliesQueryLatestCompleteData = ({
+  startDate,
+  ignoreCache,
+}: {
+  startDate?: string | null;
+  ignoreCache?: boolean;
+}): TokenSupply[] | undefined => {
+  const tokenSupplyResults = useTokenSuppliesQueryComplete({ startDate, ignoreCache });
   const [latestData, setLatestData] = useState<TokenSupply[]>();
 
   useEffect(() => {
@@ -189,22 +230,30 @@ export const useTokenSuppliesQueryLatestCompleteData = (
 export const useMetricsQuery = ({
   startDate,
   includeContentRecords,
+  ignoreCache,
 }: {
   startDate?: string | null;
   includeContentRecords?: boolean;
+  ignoreCache?: boolean;
 }) => {
   return useFederatedSubgraphQuery({
     operationName: "paginated/metrics",
     input: {
       startDate: startDate || "",
       includeRecords: includeContentRecords || false,
+      ignoreCache: ignoreCache || false,
     },
     enabled: startDate != null,
+    retry: 3, // Queries with long periods and with includeRecords = true will take a while if not cached, leading to a timeout
+    retryDelay: 5000,
   });
 };
 
-export const useMetricsLatestQuery = () => {
+export const useMetricsLatestQuery = ({ ignoreCache }: { ignoreCache?: boolean }) => {
   return useFederatedSubgraphQuery({
     operationName: "latest/metrics",
+    input: {
+      ignoreCache: ignoreCache || false,
+    },
   });
 };
diff --git a/src/hooks/useProtocolMetrics.ts b/src/hooks/useProtocolMetrics.ts
@@ -1,7 +1,7 @@
 import { useMetricsLatestQuery } from "src/hooks/useFederatedSubgraphQuery";
 
-export const useTotalValueDeposited = (): number | undefined => {
-  const { data } = useMetricsLatestQuery();
+export const useTotalValueDeposited = ({ ignoreCache }: { ignoreCache?: boolean }): number | undefined => {
+  const { data } = useMetricsLatestQuery({ ignoreCache });
 
   if (!data) {
     return undefined;
@@ -19,8 +19,8 @@ export const useTotalValueDeposited = (): number | undefined => {
  *
  * @returns
  */
-export const useOhmPrice = (): number | undefined => {
-  const { data } = useMetricsLatestQuery();
+export const useOhmPrice = ({ ignoreCache }: { ignoreCache?: boolean }): number | undefined => {
+  const { data } = useMetricsLatestQuery({ ignoreCache });
 
   if (!data) {
     return undefined;
@@ -38,8 +38,8 @@ export const useOhmPrice = (): number | undefined => {
  *
  * @returns
  */
-export const useGOhmPrice = (): number | undefined => {
-  const { data } = useMetricsLatestQuery();
+export const useGOhmPrice = ({ ignoreCache }: { ignoreCache?: boolean }): number | undefined => {
+  const { data } = useMetricsLatestQuery({ ignoreCache });
 
   if (!data) {
     return undefined;
@@ -53,8 +53,8 @@ export const useGOhmPrice = (): number | undefined => {
  *
  * @returns
  */
-export const useCurrentIndex = (): number | undefined => {
-  const { data } = useMetricsLatestQuery();
+export const useCurrentIndex = ({ ignoreCache }: { ignoreCache?: boolean }): number | undefined => {
+  const { data } = useMetricsLatestQuery({ ignoreCache });
 
   if (!data) {
     return undefined;

diff --git a/src/hooks/useTokenRecordsMetrics.ts b/src/hooks/useTokenRecordsMetrics.ts
@@ -6,12 +6,12 @@ import { useMetricsLatestQuery } from "src/hooks/useFederatedSubgraphQuery";
  *
  * @returns
  */
-export const useTreasuryMarketValueLatest = (): number | undefined => {
+export const useTreasuryMarketValueLatest = (ignoreCache?: boolean): number | undefined => {
   // State variables
   const [assetValue, setAssetValue] = useState<number>();
 
   // Query hooks
-  const { data: metricResult } = useMetricsLatestQuery();
+  const { data: metricResult } = useMetricsLatestQuery({ ignoreCache });
 
   useEffect(() => {
     if (!metricResult) {

diff --git a/src/hooks/useTokenSupplyMetrics.ts b/src/hooks/useTokenSupplyMetrics.ts
@@ -1,9 +1,9 @@
 import { useEffect, useState } from "react";
 import { useMetricsLatestQuery } from "src/hooks/useFederatedSubgraphQuery";
 
-export const useOhmCirculatingSupply = (earliestDate?: string | null): number | undefined => {
+export const useOhmCirculatingSupply = ({ ignoreCache }: { ignoreCache?: boolean }): number | undefined => {
   // Query hooks
-  const { data: metricResult } = useMetricsLatestQuery();
+  const { data: metricResult } = useMetricsLatestQuery({ ignoreCache });
 
   // State variables
   const [circulatingSupply, setCirculatingSupply] = useState<number>();
@@ -20,9 +20,9 @@ export const useOhmCirculatingSupply = (earliestDate?: string | null): number |
   return circulatingSupply;
 };
 
-export const useOhmFloatingSupply = (earliestDate?: string | null): number | undefined => {
+export const useOhmFloatingSupply = ({ ignoreCache }: { ignoreCache?: boolean }): number | undefined => {
   // Query hooks
-  const { data: metricResult } = useMetricsLatestQuery();
+  const { data: metricResult } = useMetricsLatestQuery({ ignoreCache });
 
   // State variables
   const [floatingSupply, setFloatingSupply] = useState<number>();
@@ -39,9 +39,9 @@ export const useOhmFloatingSupply = (earliestDate?: string | null): number | und
   return floatingSupply;
 };
 
-export const useOhmBackedSupply = (earliestDate?: string | null): number | undefined => {
+export const useOhmBackedSupply = ({ ignoreCache }: { ignoreCache?: boolean }): number | undefined => {
   // Query hooks
-  const { data: metricResult } = useMetricsLatestQuery();
+  const { data: metricResult } = useMetricsLatestQuery({ ignoreCache });
 
   // State variables
   const [backedSupply, setBackedSupply] = useState<number>();
@@ -58,9 +58,9 @@ export const useOhmBackedSupply = (earliestDate?: string | null): number | undef
   return backedSupply;
 };
 
-export const useOhmTotalSupply = (earliestDate?: string | null): number | undefined => {
+export const useOhmTotalSupply = ({ ignoreCache }: { ignoreCache?: boolean }): number | undefined => {
   // Query hooks
-  const { data: metricResult } = useMetricsLatestQuery();
+  const { data: metricResult } = useMetricsLatestQuery({ ignoreCache });
 
   // State variables
   const [totalSupply, setTotalSupply] = useState<number>();

diff --git a/src/hooks/useTreasuryMetrics.ts b/src/hooks/useTreasuryMetrics.ts
@@ -6,11 +6,13 @@ import { useMetricsLatestQuery } from "src/hooks/useFederatedSubgraphQuery";
  *
  * @returns [marketCap, ohmPrice, circulatingSupply]
  */
-export const useMarketCap = (
-  earliestDate?: string | null,
-): [number | undefined, number | undefined, number | undefined] => {
+export const useMarketCap = ({
+  ignoreCache,
+}: {
+  ignoreCache?: boolean;
+}): [number | undefined, number | undefined, number | undefined] => {
   // Query hooks
-  const { data: metricResult } = useMetricsLatestQuery();
+  const { data: metricResult } = useMetricsLatestQuery({ ignoreCache });
 
   // State variables
   const [ohmPrice, setOhmPrice] = useState<number>();
@@ -38,9 +40,9 @@ export const useMarketCap = (
  *
  * @returns [liquidBackingPerBackedOhm, liquidBacking, backedOhm]
  */
-export const useLiquidBackingPerOhmBacked = (earliestDate?: string | null): [number, number, number] => {
+export const useLiquidBackingPerOhmBacked = ({ ignoreCache }: { ignoreCache?: boolean }): [number, number, number] => {
   // Query hooks
-  const { data: metricResult } = useMetricsLatestQuery();
+  const { data: metricResult } = useMetricsLatestQuery({ ignoreCache });
 
   // State variables
   const [liquidBackingPerOhmBacked, setLiquidBackingPerOhmBacked] = useState(0);
@@ -65,9 +67,13 @@ export const useLiquidBackingPerOhmBacked = (earliestDate?: string | null): [num
  *
  * @returns [liquidBackingPerGOhm, liquidBacking, latestIndex, ohmFloatingSupply]
  */
-export const useLiquidBackingPerGOhm = (earliestDate?: string | null): [number, number, number, number] => {
+export const useLiquidBackingPerGOhm = ({
+  ignoreCache,
+}: {
+  ignoreCache?: boolean;
+}): [number, number, number, number] => {
   // Query hooks
-  const { data: metricResult } = useMetricsLatestQuery();
+  const { data: metricResult } = useMetricsLatestQuery({ ignoreCache });
 
   // State variables
   const [liquidBacking, setLiquidBacking] = useState(0);

diff --git a/src/views/TreasuryDashboard/TreasuryDashboard.tsx b/src/views/TreasuryDashboard/TreasuryDashboard.tsx
@@ -49,6 +49,10 @@ const MetricsDashboard = () => {
    * and not load data until earliestDate is a valid value.
    */
   const earliestDate = !daysPrior ? null : getISO8601String(adjustDateByDays(new Date(), -1 * parseInt(daysPrior)));
+
+  // State variable for ignoring the API cache
+  const [ignoreCache, setIgnoreCache] = useState<boolean | undefined>();
+
   /**
    * State variable for the number of days to offset each subgraph query with.
    *
@@ -68,6 +72,13 @@ const MetricsDashboard = () => {
     const queryDays = searchParams.get(PARAM_DAYS) || DEFAULT_DAYS.toString();
     setDaysPrior(queryDays);
 
+    // Get the ignoreCache parameter
+    const queryIgnoreCache = searchParams.get("ignoreCache");
+    if (queryIgnoreCache && queryIgnoreCache.toLowerCase() == "true") {
+      console.info("Setting ignoreCache to true");
+      setIgnoreCache(true);
+    }
+
     // Get the token or use the default
     const queryToken = searchParams.get(PARAM_TOKEN) || PARAM_TOKEN_OHM;
     setToken(queryToken);
@@ -85,6 +96,7 @@ const MetricsDashboard = () => {
   const sharedMetricProps: AbstractedMetricProps & MetricSubgraphProps = {
     ...baseMetricProps,
     earliestDate: earliestDate,
+    ignoreCache: ignoreCache,
   };
 
   /**
@@ -212,27 +224,32 @@ const MetricsDashboard = () => {
               activeToken={token}
               earliestDate={earliestDate}
               subgraphDaysOffset={daysOffset}
+              ignoreCache={ignoreCache}
             />
           </Paper>
         </Grid>
         <Grid item xs={12}>
           <Paper {...paperProps} style={paperStyles}>
-            <TreasuryAssets earliestDate={earliestDate} subgraphDaysOffset={daysOffset} />
+            <TreasuryAssets earliestDate={earliestDate} subgraphDaysOffset={daysOffset} ignoreCache={ignoreCache} />
           </Paper>
         </Grid>
         <Grid item xs={12}>
           <Paper {...paperProps} style={paperStyles}>
-            <ProtocolOwnedLiquidityGraph earliestDate={earliestDate} subgraphDaysOffset={daysOffset} />
+            <ProtocolOwnedLiquidityGraph
+              earliestDate={earliestDate}
+              subgraphDaysOffset={daysOffset}
+              ignoreCache={ignoreCache}
+            />
           </Paper>
         </Grid>
         <Grid item xs={12}>
           <Paper {...paperProps} style={paperStyles}>
-            <OhmSupply earliestDate={earliestDate} subgraphDaysOffset={daysOffset} />
+            <OhmSupply earliestDate={earliestDate} subgraphDaysOffset={daysOffset} ignoreCache={ignoreCache} />
           </Paper>
         </Grid>
         <Grid item xs={12}>
           <Paper {...paperProps} style={paperStyles}>
-            <DataWarning />
+            <DataWarning ignoreCache={ignoreCache} />
           </Paper>
         </Grid>
         <Grid item xs={12}>