refactor: improve type safety in configuration handling

Author: cctdaniel

governance/xc_admin/packages/xc_admin_common/src/programs/core/core_functions.ts

@@ -132,21 +132,13 @@ function sortData(data: DownloadableConfig): DownloadableConfig {
   return sortedData;
 }
 
-/**
- * Get the Pyth Core program address for the given cluster
- */
-export function getProgramAddress(cluster: PythCluster): PublicKey {
-  return getPythProgramKeyForCluster(cluster);
-}
-
 /**
  * Parse raw on-chain accounts into the Pyth Core configuration format
  */
-export function getConfig(params: GetConfigParams): RawConfig {
-  if (params.programType !== ProgramType.PYTH_CORE) {
-    throw new Error("Invalid program type for Core getConfig");
-  }
-
+export function getConfig(
+  params: CoreConfigParams & { programType: ProgramType.PYTH_CORE },
+): RawConfig {
+  // No need for runtime check since it's enforced by the type system
   const accounts = params.accounts;
 
   // Create a map of parsed base data for each account to avoid repeated parsing

governance/xc_admin/packages/xc_admin_common/src/programs/lazer/lazer_functions.ts

@@ -11,7 +11,7 @@ import { ProgramType } from "../types";
 /**
  * Program ID for the Pyth Lazer program
  */
-const LAZER_PROGRAM_ID = new PublicKey(
+export const LAZER_PROGRAM_ID = new PublicKey(
   "pytd2yyk641x7ak7mkaasSJVXh6YYZnC7wTmtgAyxPt",
 );
 
@@ -60,18 +60,6 @@ export type LazerFeed = {
   // Add other feed-specific properties as needed
 };
 
-/**
- * Get the program address for the given cluster
- *
- * @param cluster The Pyth cluster to get the address for
- * @returns The program address
- */
-export function getProgramAddress(cluster: PythCluster): PublicKey {
-  // Currently using the same mock address for all clusters
-  // Will be updated with actual addresses for each cluster when available
-  return LAZER_PROGRAM_ID;
-}
-
 /**
  * Check if the Pyth Lazer program is available on the specified cluster
  *
@@ -80,9 +68,9 @@ export function getProgramAddress(cluster: PythCluster): PublicKey {
  */
 export function isAvailableOnCluster(cluster: PythCluster): boolean {
   return (
-    cluster === "pythnet" ||
-    cluster === "mainnet-beta" ||
-    cluster === "devnet" ||
+    cluster === "pythnet" ??
+    cluster === "mainnet-beta" ??
+    cluster === "devnet" ??
     cluster === "testnet"
   );
 }
@@ -93,16 +81,13 @@ export function isAvailableOnCluster(cluster: PythCluster): boolean {
  * @param params Parameters to fetch Lazer configuration
  * @returns Promise resolving to Lazer-specific configuration object
  */
-export function getConfig(params: GetConfigParams): LazerConfig {
-  // Only process if this is a Lazer config request
-  if (params.programType !== ProgramType.PYTH_LAZER) {
-    throw new Error("Invalid program type for Lazer getConfig");
-  }
+export function getConfig(
+  params: LazerConfigParams & { programType: ProgramType.PYTH_LAZER },
+): LazerConfig {
+  // No need for runtime check since it's enforced by the type system
 
-  // Cast to LazerConfigParams to extract the properties
-  const { endpoint, network, options } = params as {
-    programType: ProgramType.PYTH_LAZER;
-  } & LazerConfigParams;
+  // Extract the properties
+  const { endpoint, network, options } = params;
 
   // Example implementation that would fetch data from a non-Solana source
   // For now, return a placeholder with empty feeds

governance/xc_admin/packages/xc_admin_common/src/programs/program_registry.ts

@@ -1,16 +1,18 @@
 import { AccountInfo, PublicKey } from "@solana/web3.js";
-import { PythCluster } from "@pythnetwork/client";
+import { getPythProgramKeyForCluster, PythCluster } from "@pythnetwork/client";
 import {
   DownloadableConfig,
   ProgramType,
   ProgramConfig,
-  GetConfigParams,
   ValidationResult,
+  RawConfig,
+  GetConfigParams,
 } from "./types";
 
 // Import functions from each program implementation
 import * as pythCore from "./core/core_functions";
 import * as pythLazer from "./lazer/lazer_functions";
+import { LazerConfig, LAZER_PROGRAM_ID } from "./lazer/lazer_functions";
 
 /**
  * Function to get the program address for each program type
@@ -19,8 +21,9 @@ export const getProgramAddress: Record<
   ProgramType,
   (cluster: PythCluster) => PublicKey
 > = {
-  [ProgramType.PYTH_CORE]: pythCore.getProgramAddress,
-  [ProgramType.PYTH_LAZER]: pythLazer.getProgramAddress,
+  [ProgramType.PYTH_CORE]: (cluster: PythCluster) =>
+    getPythProgramKeyForCluster(cluster),
+  [ProgramType.PYTH_LAZER]: () => LAZER_PROGRAM_ID,
 };
 
 /**
@@ -36,13 +39,18 @@ export const isAvailableOnCluster: Record<
 
 /**
  * Function to get configuration for each program type
+ * Uses discriminated union to ensure type safety
  */
-export const getConfig: Record<
-  ProgramType,
-  (params: GetConfigParams) => ProgramConfig
-> = {
-  [ProgramType.PYTH_CORE]: pythCore.getConfig,
-  [ProgramType.PYTH_LAZER]: pythLazer.getConfig,
+export const getConfig: {
+  [ProgramType.PYTH_CORE]: (
+    params: Extract<GetConfigParams, { programType: ProgramType.PYTH_CORE }>,
+  ) => RawConfig;
+  [ProgramType.PYTH_LAZER]: (
+    params: Extract<GetConfigParams, { programType: ProgramType.PYTH_LAZER }>,
+  ) => LazerConfig;
+} = {
+  [ProgramType.PYTH_CORE]: (params) => pythCore.getConfig(params),
+  [ProgramType.PYTH_LAZER]: (params) => pythLazer.getConfig(params),
 };
 
 /**

governance/xc_admin/packages/xc_admin_common/src/programs/types.ts

@@ -72,12 +72,11 @@ export type RawConfig = {
 
 /**
  * Union type for configuration parameters that can vary by program type
+ * This is a discriminated union type that enforces program type at compile time
  */
 export type GetConfigParams =
-  | ({
-      programType: ProgramType.PYTH_CORE;
-    } & CoreConfigParams)
-  | ({ programType: ProgramType.PYTH_LAZER } & LazerConfigParams);
+  | (CoreConfigParams & { programType: ProgramType.PYTH_CORE })
+  | (LazerConfigParams & { programType: ProgramType.PYTH_LAZER });
 
 /**
  * Type for downloadable price account configuration