Release/v2.6.0 (#21)

* Update changelog + update packages
* 2.6.0

Author: ali-bahjati

CHANGELOG.md

@@ -1,18 +1,33 @@
 # Changelog
 
-### 2.5.1
+## 2.6.0
+
+### Added
+- Checks current slot when parsing a Price account and set status to unknown if price is stale. Being stale means it is not updated in `MAX_SLOT_DIFFERENCE` slots (currently 25).
+- Adds status field in PriceData to access the current status (considering price getting stale) easier.
+
+### Changed
+- Converts Some type/status structs to enums to be able to use them in a cleaner way. It's backward compatible.
+
+
+## 2.5.3
+
+### Fixed
+Updated tests for Pyth symbology change
+
+## 2.5.1
 
 ### Changed
 
 Improved error message when passing an invalid cluster name to `pythProgramKeyForCluster`
 
-### 2.5.0
+## 2.5.0
 
 ### Changed
 
 Restructure `drv2` field in `PriceData` to `minPublishers` and other future drv values
 
-### 2.4.0
+## 2.4.0
 
 ### Changed
 
@@ -22,7 +37,7 @@ Product only define `price` and `confidence` fields if it currently has a valid
 
 Memory leak in an underlying library
 
-### 2.3.2
+## 2.3.2
 
 ### Added
 

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "@pythnetwork/client",
-  "version": "2.5.3",
+  "version": "2.6.0",
   "description": "Client for consuming Pyth price data",
   "homepage": "https://pyth.network",
   "main": "lib/index.js",

package.json

@@ -1,96 +1,96 @@
-import { Commitment, Connection, PublicKey } from "@solana/web3.js";
-import { Product, PriceData, parseProductData, parsePriceData, parseBaseData, AccountType } from ".";
+import { Commitment, Connection, PublicKey } from '@solana/web3.js'
+import { Product, PriceData, parseProductData, parsePriceData, parseBaseData, AccountType } from '.'
 
 export interface PythHttpClientResult {
-  assetTypes: string[];
-  symbols: string[];
-  products: Product[];
-  productFromSymbol: Map<string, Product>;
-  productPrice: Map<string, PriceData>;
-  prices: PriceData[];
+  assetTypes: string[]
+  symbols: string[]
+  products: Product[]
+  productFromSymbol: Map<string, Product>
+  productPrice: Map<string, PriceData>
+  prices: PriceData[]
 }
 
 /**
  * Reads Pyth price data from a solana web3 connection. This class uses a single HTTP call.
  * Use the method getData() to get updated prices values.
  */
 export class PythHttpClient {
-  connection: Connection;
-  pythProgramKey: PublicKey;
-  commitment: Commitment;
+  connection: Connection
+  pythProgramKey: PublicKey
+  commitment: Commitment
 
   constructor(connection: Connection, pythProgramKey: PublicKey, commitment: Commitment = 'finalized') {
-    this.connection = connection;
-    this.pythProgramKey = pythProgramKey;
-    this.commitment = commitment;
+    this.connection = connection
+    this.pythProgramKey = pythProgramKey
+    this.commitment = commitment
   }
 
   /*
-  * Get Pyth Network account information and return actual price state.
-  * The result contains lists of asset types, product symbols and their prices.
-  */
+   * Get Pyth Network account information and return actual price state.
+   * The result contains lists of asset types, product symbols and their prices.
+   */
   public async getData(): Promise<PythHttpClientResult> {
-    const assetTypes = new Set<string>();
-    const productSymbols = new Set<string>();
+    const assetTypes = new Set<string>()
+    const productSymbols = new Set<string>()
     const products = new Set<Product>()
     const productFromSymbol = new Map<string, Product>()
     const productPrice = new Map<string, PriceData>()
-    const prices = new Array<PriceData>();
+    const prices = new Array<PriceData>()
 
     // Retrieve data from blockchain
-    const accountList = await this.connection.getProgramAccounts(this.pythProgramKey, this.commitment);
+    const accountList = await this.connection.getProgramAccounts(this.pythProgramKey, this.commitment)
 
     // Popolate producs and prices
-    const priceDataQueue = new Array<PriceData>();
-    const productAccountKeyToProduct = new Map<string, Product>();
-    const currentSlot = await this.connection.getSlot(this.commitment);
+    const priceDataQueue = new Array<PriceData>()
+    const productAccountKeyToProduct = new Map<string, Product>()
+    const currentSlot = await this.connection.getSlot(this.commitment)
 
-    accountList.forEach(singleAccount => {
-      const base = parseBaseData(singleAccount.account.data);
+    accountList.forEach((singleAccount) => {
+      const base = parseBaseData(singleAccount.account.data)
       if (base) {
         switch (base.type) {
           case AccountType.Mapping:
             // We can skip these because we're going to get every account owned by this program anyway.
-            break;
+            break
           case AccountType.Product:
             const productData = parseProductData(singleAccount.account.data)
 
             productAccountKeyToProduct.set(singleAccount.pubkey.toBase58(), productData.product)
-            assetTypes.add(productData.product.asset_type);
-            productSymbols.add(productData.product.symbol);
-            products.add(productData.product);
-            productFromSymbol.set(productData.product.symbol, productData.product);
-            break;
+            assetTypes.add(productData.product.asset_type)
+            productSymbols.add(productData.product.symbol)
+            products.add(productData.product)
+            productFromSymbol.set(productData.product.symbol, productData.product)
+            break
           case AccountType.Price:
             const priceData = parsePriceData(singleAccount.account.data, currentSlot)
             priceDataQueue.push(priceData)
-            break;
+            break
           case AccountType.Test:
-            break;
+            break
           default:
             throw new Error(`Unknown account type: ${base.type}. Try upgrading pyth-client.`)
         }
       }
-    });
+    })
 
-    priceDataQueue.forEach(priceData => {
+    priceDataQueue.forEach((priceData) => {
       const product = productAccountKeyToProduct.get(priceData.productAccountKey.toBase58())
 
       if (product) {
-        productPrice.set(product.symbol, priceData);
-        prices.push(priceData);
+        productPrice.set(product.symbol, priceData)
+        prices.push(priceData)
       }
-    });
+    })
 
     const result: PythHttpClientResult = {
       assetTypes: Array.from(assetTypes),
       symbols: Array.from(productSymbols),
       products: Array.from(products),
       productFromSymbol,
       productPrice,
-      prices
-    };
+      prices,
+    }
 
-    return result;
+    return result
   }
-}
+}