clean up confusing env/network mess

Author: artursapek

wormhole-connect/src/config/index.ts

@@ -5,35 +5,42 @@ import {
   ForeignAssetCache,
   ChainResourceMap,
 } from '@wormhole-foundation/wormhole-connect-sdk';
+import { Network as NetworkLegacy } from '@certusone/wormhole-sdk'; // TODO remove
 import MAINNET from './mainnet';
 import TESTNET from './testnet';
 import DEVNET from './devnet';
 import type { WormholeConnectConfig } from './types';
-import { Environment, InternalConfig, Route, TokensConfig } from './types';
+import { Network, InternalConfig, Route, TokensConfig } from './types';
 import { mergeCustomTokensConfig, validateDefaults } from './utils';
 
-type Network = 'MAINNET' | 'TESTNET' | 'DEVNET';
-
 export function buildConfig(
   customConfig?: WormholeConnectConfig,
 ): InternalConfig {
-  const env = (customConfig?.env ||
+  const network = (
+    customConfig?.network ||
+    customConfig?.env || // TODO remove; deprecated
     import.meta.env.REACT_APP_CONNECT_ENV?.toLowerCase() ||
-    'testnet') as Environment;
+    'testnet'
+  ).toLowerCase() as Network;
 
-  if (!['mainnet', 'testnet', 'devnet'].includes(env))
-    throw new Error(`Invalid env "${env}"`);
+  if (!['mainnet', 'testnet', 'devnet'].includes(network))
+    throw new Error(`Invalid env "${network}"`);
 
-  const network: Network = env.toUpperCase() as Network;
+  // TODO remove
+  // SDKv1 uses ALLCAPS network consts like "MAINNET"
+  // Connect uses lowercase like "mainnet"
+  // SDKv2 uses capitalized like "Mainnet"
+  // It's a mess
+  const networkLegacy = network.toUpperCase() as NetworkLegacy;
 
-  const networkData = { MAINNET, DEVNET, TESTNET }[network];
+  const networkData = { MAINNET, DEVNET, TESTNET }[networkLegacy]!;
 
   const tokens = mergeCustomTokensConfig(
     networkData.tokens,
     customConfig?.tokensConfig,
   );
 
-  const sdkConfig = WormholeContext.getConfig(network);
+  const sdkConfig = WormholeContext.getConfig(networkLegacy);
 
   const rpcs = Object.assign(
     {},
@@ -42,17 +49,17 @@ export function buildConfig(
     customConfig?.rpcs,
   );
 
-  const wh = getWormholeContext(network, sdkConfig, tokens, rpcs);
+  const wh = getWormholeContext(networkLegacy, sdkConfig, tokens, rpcs);
 
   return {
     wh,
     sdkConfig,
 
     // TODO remove either env or network from this
     // some code uses lowercase, some uppercase... :(
-    env,
     network,
-    isMainnet: env === 'mainnet',
+    networkLegacy,
+    isMainnet: network === 'mainnet',
     // External resources
     rpcs,
     rest: Object.assign(
@@ -66,7 +73,7 @@ export function buildConfig(
       mainnet: 'https://api.wormholescan.io/',
       testnet: 'https://api.testnet.wormholescan.io/',
       devnet: '',
-    }[env],
+    }[network],
     wormholeRpcHosts: {
       mainnet: [
         'https://wormhole-v2-mainnet-api.mcf.rocks',
@@ -79,7 +86,7 @@ export function buildConfig(
         'https://guardian-02.testnet.xlabs.xyz',
       ],
       devnet: ['http://localhost:7071'],
-    }[env],
+    }[network],
     coinGeckoApiKey: customConfig?.coinGeckoApiKey,
 
     // White lists
@@ -106,7 +113,7 @@ export function buildConfig(
       devnet: '',
       testnet:
         'https://wormhole-foundation.github.io/example-token-bridge-ui/#/register',
-    }[env],
+    }[network],
     bridgeDefaults: validateDefaults(customConfig?.bridgeDefaults),
     cctpWarning: customConfig?.cctpWarning?.href || '',
     pageHeader: customConfig?.pageHeader,
@@ -132,7 +139,7 @@ const config = buildConfig();
 export default config;
 
 function getWormholeContext(
-  network: Network,
+  network: NetworkLegacy,
   sdkConfig: WormholeConfig,
   tokens: TokensConfig,
   rpcs: ChainResourceMap,

wormhole-connect/src/config/types.ts

@@ -1,4 +1,4 @@
-import { Network } from '@certusone/wormhole-sdk';
+import { Network as NetworkLegacy } from '@certusone/wormhole-sdk';
 import {
   ChainConfig as BaseChainConfig,
   ChainName,
@@ -57,7 +57,7 @@ export enum Route {
 
 export type SupportedRoutes = keyof typeof Route;
 
-export type Environment = 'mainnet' | 'testnet' | 'devnet';
+export type Network = 'mainnet' | 'testnet' | 'devnet';
 
 // TODO: preference is fromChain/toChain, but want to keep backwards compatibility
 export interface BridgeDefaults {
@@ -69,7 +69,8 @@ export interface BridgeDefaults {
 
 // This is the integrator-provided JSON config
 export interface WormholeConnectConfig {
-  env?: Environment;
+  env?: Network; // TODO REMOVE; DEPRECATED
+  network?: Network; // New name for this, consistent with SDKv2
 
   // External resources
   rpcs?: ChainResourceMap;
@@ -78,7 +79,8 @@ export interface WormholeConnectConfig {
   coinGeckoApiKey?: string;
 
   // White lists
-  networks?: ChainName[];
+  networks?: ChainName[]; // TODO REMOVE; DEPRECATED
+  chains?: ChainName[]; // New name for this, consistent with SDKv2
   tokens?: string[];
 
   // Custom tokens
@@ -121,8 +123,9 @@ export interface InternalConfig {
   wh: WormholeContext;
   sdkConfig: WormholeConfig;
 
-  env: Environment;
-  network: Network; // TODO reduce these to just one...
+  network: Network;
+  networkLegacy: NetworkLegacy; // TODO remove...
+
   isMainnet: boolean;
 
   // External resources

wormhole-connect/src/routes/cosmosGateway/cosmosGateway.ts

@@ -207,7 +207,7 @@ export class CosmosGatewayRoute extends BaseRoute {
     };
 
     const destChainName = config.wh.toChainName(destChain);
-    const gasDenom = getNativeDenom(destChainName, config.network);
+    const gasDenom = getNativeDenom(destChainName, config.networkLegacy);
 
     const tx: CosmosTransaction = {
       fee: calculateFee(1000000, `1.0${gasDenom}`),

wormhole-connect/src/utils/wallet/sei.ts

@@ -16,7 +16,7 @@ export const getSeiChainId = (env: Network) =>
 
 export async function fetchOptions() {
   const seiWallets = getSupportedWallets({
-    chainId: getSeiChainId(config.network) as SeiChainId,
+    chainId: getSeiChainId(config.networkLegacy) as SeiChainId,
     rpcUrl: config.rpcs.sei || '',
   });
 

wormhole-connect/src/views/Redeem/ExplorerLink.tsx

@@ -39,7 +39,7 @@ function ExplorerLink(props: ExplorerLinkProps) {
       explorerLink = `${chainConfig.explorerUrl}transaction/${props.txHash}`;
     } else if (chainConfig.key === 'osmosis') {
       explorerLink =
-        config.network === 'TESTNET'
+        config.network === 'testnet'
           ? `${chainConfig.explorerUrl}txs/${props.txHash}`
           : `${chainConfig.explorerUrl}transactions/${props.txHash}`;
     } else {