Move staleness check to new endpoint (#278)

* move staleness to new endpoint

* actually send the response

* Add schema

* Fix freshness metric to use publish time instead of attestation Time

* Rename endpoint to /api/ + small fix

* Bump version

Co-authored-by: Jayant Krishnamurthy <[email protected]>
Co-authored-by: Ali Behjati <[email protected]>

Author: 3 people

devnet/pyth-price-service.yaml

@@ -70,7 +70,5 @@ spec:
               value: '5'
             - name: READINESS_NUM_LOADED_SYMBOLS
               value: '6'
-            - name: READINESS_FRESHNESS_TIME_SECONDS
-              value: '10'
             - name: LOG_LEVEL
               value: debug

third_party/pyth/price-service/.env.sample

@@ -15,7 +15,6 @@ SPY_SERVICE_FILTERS=[{"chain_id":1,"emitter_address":"71f8dcb863d176e2c420ad6610
 # Number of seconds to sync with spy to be sure to have latest messages
 READINESS_SPY_SYNC_TIME_SECONDS=60
 READINESS_NUM_LOADED_SYMBOLS=5
-READINESS_FRESHNESS_TIME_SECONDS=10
 
 WS_PORT=6200
 REST_PORT=4200

third_party/pyth/price-service/docker-compose.yaml

@@ -24,7 +24,6 @@ services:
       - PROM_PORT=8081
       - READINESS_SPY_SYNC_TIME_SECONDS=60
       - READINESS_NUM_LOADED_SYMBOLS=8
-      - READINESS_FRESHNESS_TIME_SECONDS=10
       - LOG_LEVEL=debug
     healthcheck:
       test:

third_party/pyth/price-service/package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "@pythnetwork/pyth-price-service",
-  "version": "1.0.0",
+  "version": "1.4.1",
   "description": "Pyth Price Service",
   "main": "index.js",
   "scripts": {

third_party/pyth/price-service/package.json

@@ -35,7 +35,6 @@ async function run() {
           envOrErr("READINESS_SPY_SYNC_TIME_SECONDS")
         ),
         numLoadedSymbols: parseInt(envOrErr("READINESS_NUM_LOADED_SYMBOLS")),
-        freshnessTimeSeconds: parseInt(envOrErr("READINESS_FRESHNESS_TIME_SECONDS")),
       },
     },
     promClient

third_party/pyth/price-service/src/index.ts

@@ -43,7 +43,6 @@ export interface PriceStore {
 type ListenerReadinessConfig = {
   spySyncTimeSeconds: number;
   numLoadedSymbols: number;
-  freshnessTimeSeconds: number;
 };
 
 type ListenerConfig = {
@@ -246,16 +245,7 @@ export class Listener implements PriceStore {
     if (this.priceFeedVaaMap.size < this.readinessConfig.numLoadedSymbols) {
       return false;
     }
-    let priceIds = [...this.getPriceIds()];
-    let arePricesFresh = priceIds.every(
-      (priceId) =>
-        currentTime -
-          this.priceFeedVaaMap.get(priceId)!.priceFeed.publishTime <=
-        this.readinessConfig.freshnessTimeSeconds
-    );
-    if (!arePricesFresh) {
-      return false;
-    }
+
     return true;
   }
 }

third_party/pyth/price-service/src/listen.ts

@@ -5,10 +5,11 @@ import { Server } from "http";
 import { StatusCodes } from "http-status-codes";
 import morgan from "morgan";
 import responseTime from "response-time";
-import { DurationInMs, DurationInSec } from "./helpers";
+import { DurationInMs, DurationInSec, TimestampInSec } from "./helpers";
 import { PriceStore } from "./listen";
 import { logger } from "./logging";
 import { PromClient } from "./promClient";
+import { HexString } from "@pythnetwork/pyth-sdk-js";
 
 const MORGAN_LOG_FORMAT =
   ':remote-addr - :remote-user ":method :url HTTP/:http-version"' +
@@ -104,7 +105,7 @@ export class RestAPI {
           }
 
           const freshness: DurationInSec =
-            new Date().getTime() / 1000 - latestPriceInfo.attestationTime;
+            new Date().getTime() / 1000 - latestPriceInfo.priceFeed.publishTime;
           this.promClient?.addApiRequestsPriceFreshness(
             req.path,
             id,
@@ -162,7 +163,7 @@ export class RestAPI {
           }
 
           const freshness: DurationInSec =
-            new Date().getTime() / 1000 - latestPriceInfo.attestationTime;
+            new Date().getTime() / 1000 - latestPriceInfo.priceFeed.publishTime;
           this.promClient?.addApiRequestsPriceFreshness(
             req.path,
             id,
@@ -203,6 +204,35 @@ export class RestAPI {
     });
     endpoints.push("api/price_feed_ids");
 
+    const staleFeedsInputSchema: schema = {
+      query: Joi.object({
+        threshold: Joi.number().required(),
+      }).required(),
+    };
+    app.get("/api/stale_feeds",
+      validate(staleFeedsInputSchema),
+      (req: Request, res: Response) => {
+        let stalenessThresholdSeconds = Number(req.query.threshold as string);
+
+        let currentTime: TimestampInSec = Math.floor(Date.now() / 1000);
+
+        let priceIds = [...this.priceFeedVaaInfo.getPriceIds()];
+        let stalePrices: Record<HexString, number> = {}
+
+        for (let priceId of priceIds) {
+          const latency = currentTime - this.priceFeedVaaInfo.getLatestPriceInfo(priceId)!.priceFeed.publishTime
+          if (latency > stalenessThresholdSeconds) {
+            stalePrices[priceId] = latency
+          }
+        }
+
+        res.json(stalePrices);
+      }
+    );
+    endpoints.push(
+      "/api/stale_feeds?threshold=<staleness_threshold_seconds>"
+    );
+
     app.get("/ready", (_, res: Response) => {
       if (this.isReady!()) {
         res.sendStatus(StatusCodes.OK);