add pythtest cluster support (#35)

* add pythtest cluster support

* fix linting error

Author: cctdaniel

CHANGELOG.md

@@ -1,5 +1,10 @@
 # Changelog
 
+## 2.7.2
+### Changed
+- Added pythtest program key and cluster url
+- Updated examples to work with pythtest
+
 ## 2.7.1
   Moved solana/web3 to peerDependencies 
 

package.json

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

src/cluster.ts

@@ -1,14 +1,17 @@
-import { Cluster, PublicKey } from '@solana/web3.js'
+import { Cluster, clusterApiUrl, PublicKey } from '@solana/web3.js'
+
+export type PythCluster = Cluster | 'pythtest'
 
 /** Mapping from solana clusters to the public key of the pyth program. */
-const clusterToPythProgramKey: Record<Cluster, string> = {
+const clusterToPythProgramKey: Record<PythCluster, string> = {
   'mainnet-beta': 'FsJ3A3u2vn5cTVofAjvy6y5kwABJAqYWpe4975bi2epH',
   devnet: 'gSbePebfvPy7tRqimPoVecS2UsBvYv46ynrzWocc92s',
   testnet: '8tfDNiaEyrV6Q1U4DEXrEigs9DoDtkugzFbybENEbCDz',
+  pythtest: '8tfDNiaEyrV6Q1U4DEXrEigs9DoDtkugzFbybENEbCDz',
 }
 
 /** Gets the public key of the Pyth program running on the given cluster. */
-export function getPythProgramKeyForCluster(cluster: Cluster): PublicKey {
+export function getPythProgramKeyForCluster(cluster: PythCluster): PublicKey {
   if (clusterToPythProgramKey[cluster] !== undefined) {
     return new PublicKey(clusterToPythProgramKey[cluster])
   } else {
@@ -19,3 +22,13 @@ export function getPythProgramKeyForCluster(cluster: Cluster): PublicKey {
     )
   }
 }
+
+/** Retrieves the RPC API URL for the specified Pyth cluster  */
+export function getPythClusterApiUrl(cluster: PythCluster): string {
+  // TODO: Add pythnet when it's ready
+  if (cluster === 'pythtest') {
+    return 'https://api.pythtest.pyth.network'
+  } else {
+    return clusterApiUrl(cluster)
+  }
+}

src/example_http_usage.ts

@@ -1,9 +1,9 @@
-import { Cluster, clusterApiUrl, Connection } from '@solana/web3.js'
-import { getPythProgramKeyForCluster } from './cluster'
+import { Connection } from '@solana/web3.js'
+import { getPythClusterApiUrl, getPythProgramKeyForCluster, PythCluster } from './cluster'
 import { PriceStatus, PythHttpClient } from '.'
 
-const SOLANA_CLUSTER_NAME: Cluster = 'mainnet-beta'
-const connection = new Connection(clusterApiUrl(SOLANA_CLUSTER_NAME))
+const SOLANA_CLUSTER_NAME: PythCluster = 'mainnet-beta'
+const connection = new Connection(getPythClusterApiUrl(SOLANA_CLUSTER_NAME))
 const pythPublicKey = getPythProgramKeyForCluster(SOLANA_CLUSTER_NAME)
 
 async function runQuery(): Promise<void> {

src/example_ws_usage.ts

@@ -1,10 +1,10 @@
-import { Cluster, clusterApiUrl, Connection } from '@solana/web3.js'
+import { Connection } from '@solana/web3.js'
 import { PythConnection } from './PythConnection'
-import { getPythProgramKeyForCluster } from './cluster'
+import { getPythClusterApiUrl, getPythProgramKeyForCluster, PythCluster } from './cluster'
 import { PriceStatus } from '.'
 
-const SOLANA_CLUSTER_NAME: Cluster = 'mainnet-beta'
-const connection = new Connection(clusterApiUrl(SOLANA_CLUSTER_NAME))
+const SOLANA_CLUSTER_NAME: PythCluster = 'mainnet-beta'
+const connection = new Connection(getPythClusterApiUrl(SOLANA_CLUSTER_NAME))
 const pythPublicKey = getPythProgramKeyForCluster(SOLANA_CLUSTER_NAME)
 
 const pythConnection = new PythConnection(connection, pythPublicKey)