Add verbose for latestPriceFeed queries + priceFeedIds endpoint (#55)

* Add verbose as config to the connection

* Add getPriceFeedIds method

Author: ali-behjati

pyth-common-js/package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "@pythnetwork/pyth-common-js",
-  "version": "1.0.0",
+  "version": "1.1.0",
   "description": "Pyth Network Common Utils in JS",
   "author": {
     "name": "Pyth Data Association"

pyth-common-js/package.json

@@ -20,11 +20,14 @@ export type PriceServiceConnectionConfig = {
   httpRetries?: number;
   /* Optional logger (e.g: console or any logging library) to log internal events */
   logger?: Logger;
+  /* Optional verbose to request for verbose information from the service */
+  verbose?: boolean;
 };
 
 type ClientMessage = {
   type: "subscribe" | "unsubscribe";
   ids: HexString[];
+  verbose?: boolean;
 };
 
 type ServerResponse = {
@@ -51,6 +54,8 @@ export class PriceServiceConnection {
 
   private logger: undefined | Logger;
 
+  private verbose: boolean;
+
   /**
    * Custom handler for web socket errors (connection and message parsing).
    *
@@ -74,6 +79,8 @@ export class PriceServiceConnection {
       retryDelay: axiosRetry.exponentialDelay,
     });
 
+    this.verbose = config?.verbose || false;
+
     this.priceFeedCallbacks = new Map();
     this.logger = config?.logger;
     this.onWsError = (error: Error) => {
@@ -100,6 +107,7 @@ export class PriceServiceConnection {
     const response = await this.httpClient.get("/api/latest_price_feeds", {
       params: {
         ids: priceIds,
+        verbose: this.verbose,
       },
     });
     const priceFeedsJson = response.data as any[];
@@ -128,6 +136,17 @@ export class PriceServiceConnection {
     return response.data;
   }
 
+  /**
+   * Fetch the list of available price feed ids.
+   * This will throw an axios error if there is a network problem or the price service returns a non-ok response.
+   *
+   * @returns Array of hex-encoded price ids.
+   */
+  async getPriceFeedIds(): Promise<HexString[]> {
+    const response = await this.httpClient.get("/api/price_feed_ids");
+    return response.data;
+  }
+
   /**
    * Subscribe to updates for given price ids.
    *
@@ -163,6 +182,7 @@ export class PriceServiceConnection {
     const message: ClientMessage = {
       ids: newPriceIds,
       type: "subscribe",
+      verbose: this.verbose,
     };
 
     await this.wsClient?.send(JSON.stringify(message));