♻️ (chore): extract chain-related code to ./utils/chains

src/constants.ts

@@ -1,18 +1,3 @@
-import {
-  arbitrum,
-  arbitrumSepolia,
-  arbitrumGoerli,
-  foundry,
-} from 'viem/chains';
-
-/** Chains */
-export const SUPPORTED_CHAINS = {
-  arbitrum,
-  arbitrumSepolia,
-  arbitrumGoerli,
-  foundry,
-};
-
 /** Contracts */
 // Valorem Clearinghouse on Arbitrum One (mainnet) & Arbitrum Goerli (testnet)
 export const CLEAR_ADDRESS = '0x402A401B1944EBb5A3030F36Aa70d6b5794190c9';

src/entities/assets/index.ts

@@ -1,3 +1,7 @@
-export { Asset, type ERC20Token } from './asset';
+export { type ERC20Token, Asset } from './asset';
 export { OptionAssetPair } from './asset-pair';
-export { SupportedAsset, SUPPORTED_ASSETS } from './supported-asset';
+export {
+  type SupportedAssetSymbol,
+  SupportedAsset,
+  SUPPORTED_ASSETS,
+} from './supported-asset';

src/entities/assets/supported-asset.test.ts

@@ -1,6 +1,7 @@
 import { describe, expect, it } from 'vitest';
-import type { SupportedAssetSymbol, SupportedChainId } from '../../types';
-import { SUPPORTED_CHAINS } from '../../constants';
+import type { SupportedChainId } from '../../utils/chains';
+import { SUPPORTED_CHAINS } from '../../utils/chains';
+import type { SupportedAssetSymbol } from './supported-asset';
 import { SupportedAsset, SUPPORTED_ASSETS } from './supported-asset';
 
 const arbitrumWETH = SUPPORTED_ASSETS.filter(

src/entities/assets/supported-asset.ts

@@ -1,8 +1,10 @@
 import type { Address } from 'viem';
-import type { SupportedAssetSymbol, SupportedChainId } from '../../types';
+import type { SupportedChainId } from '../../utils/chains';
 import type { ERC20Token } from './asset';
 import { Asset } from './asset';
 
+export type SupportedAssetSymbol = 'USDC' | 'WETH';
+
 interface SupportedERC20Token extends ERC20Token {
   chainId: SupportedChainId;
   symbol: SupportedAssetSymbol;

src/entities/index.ts

@@ -4,6 +4,7 @@ export {
   OptionAssetPair,
   SupportedAsset,
   SUPPORTED_ASSETS,
+  type SupportedAssetSymbol,
 } from './assets';
 export {
   type ContractConstructorArgs,

src/entities/options/option-type.ts

@@ -6,11 +6,8 @@ import {
   sliceHex,
   toBytes,
 } from 'viem';
-import type {
-  OptionTypeInfo,
-  SimulatedTxRequest,
-  SupportedChainId,
-} from '../../types';
+import type { OptionTypeInfo, SimulatedTxRequest } from '../../types';
+import type { SupportedChainId } from '../../utils/chains';
 import type { Trader } from '../trader/base-trader';
 import type { ClearinghouseContract } from '../contracts/clearinghouse';
 import { SupportedAsset } from '../assets/supported-asset';

src/entities/options/subgraph-position.ts

@@ -6,6 +6,7 @@ import type {
   SubgraphOptionType,
 } from '../../lib/subgraph/types';
 import { BASE_SCALAR_BN } from '../../constants';
+import { isSupportedChainId } from '../../utils/chains';
 import { OptionType } from './option-type';
 
 export class SubgraphPosition extends OptionType {
@@ -194,8 +195,7 @@ export class SubgraphPosition extends OptionType {
     subgraphPosition: SubgraphOptionPosition;
     chainId: number;
   }) {
-    if (chainId !== 42161 && chainId !== 421613)
-      throw new Error('Unsupported chainId');
+    if (!isSupportedChainId(chainId)) throw new Error('Unsupported chainId');
 
     // determine if ERC-1155 is exercisable option or redeemable claim
     const isClaim = subgraphPosition.token.type === 2;

src/index.ts

@@ -1,7 +1,6 @@
 /* eslint-disable camelcase */
 export { CLEAR_ABI, SEAPORT_V1_5_ABI, SEAPORT_VALIDATOR_ABI } from './abi';
 export {
-  SUPPORTED_CHAINS,
   CLEAR_ADDRESS,
   CLEAR_ADDRESS_FOUNDRY,
   SEAPORT_ADDRESS,
@@ -23,6 +22,7 @@ export {
   OptionAssetPair,
   SupportedAsset,
   SUPPORTED_ASSETS,
+  type SupportedAssetSymbol,
   type ContractConstructorArgs,
   type IClearinghouse,
   type IERC20,
@@ -280,13 +280,7 @@ export {
   type SubgraphClaimERC1155,
   type SubgraphOptionType,
 } from './lib';
-export type {
-  SimulatedTxRequest,
-  SupportedChain,
-  SupportedChainId,
-  SupportedAssetSymbol,
-  OptionTypeInfo,
-} from './types';
+export type { SimulatedTxRequest, OptionTypeInfo } from './types';
 export {
   createSIWEMessage,
   toUnix,
@@ -298,5 +292,9 @@ export {
   type Market,
   type OptionData,
   type Underlying,
+  SUPPORTED_CHAINS,
+  type SupportedChain,
+  type SupportedChainId,
+  isSupportedChainId,
 } from './utils';
 export { ValoremSDK } from './sdk';

src/types.ts

@@ -5,7 +5,6 @@ import type {
   Chain,
   WriteContractParameters,
 } from 'viem';
-import type { SUPPORTED_CHAINS } from './constants';
 
 export type SimulatedTxRequest = WriteContractParameters<
   Abi,
@@ -15,12 +14,6 @@ export type SimulatedTxRequest = WriteContractParameters<
   Chain
 >;
 
-export type SupportedChain =
-  (typeof SUPPORTED_CHAINS)[keyof typeof SUPPORTED_CHAINS];
-export type SupportedChainId = SupportedChain['id'];
-
-export type SupportedAssetSymbol = 'USDC' | 'WETH';
-
 // TODO(These types need to be extended and enhanced to support the full range of types used)
 // And to favor enums and true data keys over token symbols and strings/numbers interpolated
 // throughout the codebase.

src/utils/chains.ts

@@ -0,0 +1,31 @@
+import {
+  arbitrum,
+  arbitrumSepolia,
+  arbitrumGoerli,
+  foundry,
+} from 'viem/chains';
+
+export type SupportedChain =
+  (typeof SUPPORTED_CHAINS)[keyof typeof SUPPORTED_CHAINS];
+export type SupportedChainId = SupportedChain['id'];
+
+export const SUPPORTED_CHAINS = {
+  arbitrum,
+  arbitrumSepolia,
+  arbitrumGoerli,
+  foundry,
+};
+
+/**
+ * Determines whether a given chain ID corresponds to a supported chain.
+ *
+ * @param chainId - The chain ID to check.
+ * @returns True if the chainId is supported, otherwise false.
+ */
+export function isSupportedChainId(
+  chainId: number,
+): chainId is SupportedChainId {
+  return Object.values(SUPPORTED_CHAINS)
+    .map((chain) => chain.id)
+    .includes(chainId as SupportedChainId);
+}

src/utils/index.ts

@@ -1,3 +1,9 @@
+export {
+  type SupportedChain,
+  type SupportedChainId,
+  SUPPORTED_CHAINS,
+  isSupportedChainId,
+} from './chains';
 export { createSIWEMessage } from './siwe';
 export { toUnix, get8AMUTCDate, get24HrTimestamps } from './timestamps';
 export { Brent, OptionsGreeks, TypeOfOption } from './vol';