Feat/updated api (#254)

* feat: add updated api endpoints
DLC-link · Mar 3, 2025 · 217e635 · 217e635
1 parent c31bb20
commit 217e635
Show file tree

Hide file tree

Showing 7 changed files with 106 additions and 47 deletions.
diff --git a/src/app/components/points/components/points-stats-board-action.tsx b/src/app/components/points/components/points-stats-board-action.tsx
@@ -1,4 +1,4 @@
-import { HStack, Image, Skeleton, Text, VStack, useBreakpointValue } from '@chakra-ui/react';
+import { HStack, Image, Text, VStack, useBreakpointValue } from '@chakra-ui/react';
 import { Token } from '@models/token';
 
 import { formatNumber } from '@shared/utils';
@@ -11,31 +11,23 @@ interface PointsStatsBoardActionProps {
 
 export function PointsStatsBoardAction({
   token,
-  totalSupply,
+  totalSupply = 0,
   tokenSuffix,
 }: PointsStatsBoardActionProps): React.JSX.Element {
   const isMobile = useBreakpointValue({ base: true, md: false });
   return (
     <VStack w={'100%'} h={'100%'} pr={'25px'} py={isMobile ? '5px' : '15px'} alignItems={'start'}>
-      <Skeleton isLoaded={totalSupply !== undefined} h={'100%'} w={'100%'}>
-        <VStack w={'100%'} h={'85px'} alignItems={'start'} spacing={'15px'}>
-          <HStack h={'25px'}>
-            <Image src={token.logo} alt={token.logoAlt} boxSize={'25px'} />
-            <Text color={'white'} fontWeight={200} fontSize={'md'}>
-              {`${tokenSuffix} ${token.name} `}
-            </Text>
-          </HStack>
-          {totalSupply !== undefined ? (
-            <Text color={'white'} fontWeight={200} fontSize={'3xl'}>
-              {formatNumber(totalSupply)}
-            </Text>
-          ) : (
-            <Text fontSize={'2xl'} fontWeight={200} color={'gray.500'}>
-              Loading...
-            </Text>
-          )}
-        </VStack>
-      </Skeleton>
+      <VStack w={'100%'} h={'85px'} alignItems={'start'} spacing={'15px'}>
+        <HStack h={'25px'}>
+          <Image src={token.logo} alt={token.logoAlt} boxSize={'25px'} />
+          <Text color={'white'} fontWeight={200} fontSize={'md'}>
+            {`${tokenSuffix} ${token.name} `}
+          </Text>
+        </HStack>
+        <Text color={'white'} fontWeight={200} fontSize={'3xl'}>
+          {formatNumber(totalSupply)}
+        </Text>
+      </VStack>
     </VStack>
   );
 }
diff --git a/src/app/hooks/use-mint-burn-events.ts b/src/app/hooks/use-mint-burn-events.ts
@@ -2,7 +2,7 @@ import { DetailedEvent } from '@models/ethereum-models';
 import { Merchant } from '@models/merchant';
 import { useQuery } from '@tanstack/react-query';
 
-import { MINT_BURN_EVENTS_API_URL } from '@shared/constants/api.constants';
+import { API_HELPERS } from '@shared/constants/api.constants';
 
 interface UseMintBurnEventsReturnType {
   allMintBurnEvents: DetailedEvent[] | undefined;
@@ -12,9 +12,8 @@ interface UseMintBurnEventsReturnType {
 export function useMintBurnEvents(): UseMintBurnEventsReturnType {
   async function fetchMintBurnEvents(ethereumAddress: string): Promise<DetailedEvent[]> {
     try {
-      const response = await fetch(
-        `${MINT_BURN_EVENTS_API_URL}/${appConfiguration.appEnvironment}/${ethereumAddress}`
-      );
+      const apiURL = API_HELPERS.getMintBurnEventsURL({ address: ethereumAddress });
+      const response = await fetch(apiURL);
 
       if (!response.ok) {
         throw new Error(`Error fetching mint burn events`);

diff --git a/src/app/hooks/use-points.ts b/src/app/hooks/use-points.ts
@@ -2,7 +2,7 @@ import { PointsData } from '@models/points.models';
 import { useQuery } from '@tanstack/react-query';
 import { useAccount } from 'wagmi';
 
-import { POINTS_API_URL } from '@shared/constants/api.constants';
+import { API_HELPERS } from '@shared/constants/api.constants';
 
 interface UsePointsReturnType {
   userPoints: PointsData | undefined;
@@ -13,9 +13,8 @@ export function usePoints(): UsePointsReturnType {
 
   async function fetchUserPoints(): Promise<PointsData | undefined> {
     try {
-      const response = await fetch(
-        `${POINTS_API_URL}/${appConfiguration.appEnvironment}/${address}`
-      );
+      const apiURL = API_HELPERS.getPointsURL({ address: address! });
+      const response = await fetch(apiURL);
 
       if (!response.ok) {
         throw new Error(`Error fetching user: ${address} points`);

diff --git a/src/app/hooks/use-proof-of-reserve.ts b/src/app/hooks/use-proof-of-reserve.ts
@@ -7,7 +7,7 @@ import { useQuery } from '@tanstack/react-query';
 import { unshiftValue } from 'dlc-btc-lib/utilities';
 import { pluck } from 'ramda';
 
-import { PROOF_OF_RESERVE_API_URL } from '@shared/constants/api.constants';
+import { API_HELPERS } from '@shared/constants/api.constants';
 import { NetworkType } from '@shared/constants/network.constants';
 
 export interface UseProofOfReserveReturnType {
@@ -24,9 +24,7 @@ interface ProofOfReserveByChainReturnType {
 export function useProofOfReserve(): UseProofOfReserveReturnType {
   async function fetchProofOfReserve(merchantAddress?: string): Promise<number> {
     try {
-      const apiURL = merchantAddress
-        ? `${PROOF_OF_RESERVE_API_URL}/${appConfiguration.appEnvironment}?address=${merchantAddress}`
-        : `${PROOF_OF_RESERVE_API_URL}/${appConfiguration.appEnvironment}`;
+      const apiURL = API_HELPERS.getProofOfReserveURL({ address: merchantAddress });
 
       const response = await fetch(apiURL);
 
@@ -53,14 +51,9 @@ export function useProofOfReserve(): UseProofOfReserveReturnType {
       return chain ? chain.toLowerCase() : '';
     };
 
-    const buildApiUrl = (chainParam: string): string => {
-      const baseUrl = `${PROOF_OF_RESERVE_API_URL}/${appConfiguration.appEnvironment}`;
-      return `${baseUrl}?chain=${chainParam}`;
-    };
-
     try {
       const chainParam = formatChainParam(chainName, networkType);
-      const apiUrl = buildApiUrl(chainParam);
+      const apiUrl = API_HELPERS.getProofOfReserveURL({ chain: chainParam });
 
       const response = await fetch(apiUrl);
       if (!response.ok) {

diff --git a/src/app/hooks/use-total-supply.ts b/src/app/hooks/use-total-supply.ts
@@ -1,6 +1,6 @@
 import { useQuery } from '@tanstack/react-query';
 
-import { TOTAL_SUPPLY_API_URL } from '@shared/constants/api.constants';
+import { API_HELPERS } from '@shared/constants/api.constants';
 
 interface UseTotalSupplyReturnType {
   totalSupply: number | undefined;
@@ -9,7 +9,8 @@ interface UseTotalSupplyReturnType {
 export function useTotalSupply(): UseTotalSupplyReturnType {
   const fetchTotalSupply = async () => {
     try {
-      const response = await fetch(`${TOTAL_SUPPLY_API_URL}/${appConfiguration.appEnvironment}`);
+      const apiUrl = API_HELPERS.getTotalSupplyURL({});
+      const response = await fetch(apiUrl);
 
       if (!response.ok) {
         throw new Error(`Response was not OK: ${response.status}`);

diff --git a/src/shared/constants/api.constants.ts b/src/shared/constants/api.constants.ts
@@ -1,5 +1,80 @@
-const API_URL = 'https://api.dlc.link';
-export const POINTS_API_URL = `${API_URL}/points`;
-export const PROOF_OF_RESERVE_API_URL = `${API_URL}/proof-of-reserve`;
-export const MINT_BURN_EVENTS_API_URL = `${API_URL}/mint-burn-events`;
-export const TOTAL_SUPPLY_API_URL = `${API_URL}/dlcbtc/total-supply`;
+import { AppEnvironment } from '@models/configuration';
+
+const BASE_API_URLS = {
+  [AppEnvironment.MAINNET]: 'https://api.dlc.link',
+  [AppEnvironment.TESTNET]: 'https://testnet.api.dlc.link',
+  [AppEnvironment.DEVNET]: 'https://devnet.api.dlc.link',
+  [AppEnvironment.LOCALHOST]: 'http://localhost:3000',
+};
+
+const API_PATHS = {
+  POINTS: '/v1/points',
+  PROOF_OF_RESERVE: '/v1/ibtc/proof-of-reserve',
+  MINT_BURN_EVENTS: '/v1/ibtc/mint-burn-events',
+  TOTAL_SUPPLY: '/v1/ibtc/total-supply',
+};
+
+const getBaseApiUrl = (): string => BASE_API_URLS[appConfiguration.appEnvironment];
+
+const API = {
+  BASE: getBaseApiUrl(),
+  POINTS: `${getBaseApiUrl()}${API_PATHS.POINTS}`,
+  PROOF_OF_RESERVE: `${getBaseApiUrl()}${API_PATHS.PROOF_OF_RESERVE}`,
+  MINT_BURN_EVENTS: `${getBaseApiUrl()}${API_PATHS.MINT_BURN_EVENTS}`,
+  TOTAL_SUPPLY: `${getBaseApiUrl()}${API_PATHS.TOTAL_SUPPLY}`,
+};
+
+interface ProofOfReserveOptions {
+  address?: string;
+  chain?: string;
+}
+
+interface PointsOptions {
+  address: string;
+}
+
+interface MintBurnEventsOptions {
+  address: string;
+}
+
+interface TotalSupplyOptions {
+  chain?: string;
+}
+
+export const API_HELPERS = {
+  getProofOfReserveURL(options?: ProofOfReserveOptions): string {
+    const url = new URL(`${API.PROOF_OF_RESERVE}`);
+
+    if (!options) return url.toString();
+
+    const { address, chain } = options;
+
+    if (address) url.searchParams.set('address', address);
+    if (chain) url.searchParams.set('chain', chain);
+
+    return url.toString();
+  },
+  getPointsURL(options: PointsOptions): string {
+    const { address } = options;
+
+    const url = new URL(`${API.POINTS}/${address}`);
+
+    return url.toString();
+  },
+  getMintBurnEventsURL(options: MintBurnEventsOptions): string {
+    const { address } = options;
+
+    const url = new URL(`${API.MINT_BURN_EVENTS}/${address}`);
+
+    return url.toString();
+  },
+  getTotalSupplyURL(options?: TotalSupplyOptions): string {
+    if (!options) return `${API.TOTAL_SUPPLY}`;
+
+    const { chain } = options;
+
+    const url = new URL(`${API.TOTAL_SUPPLY}${chain ? `?chain=${chain}` : ''}`);
+
+    return url.toString();
+  },
+};
diff --git a/src/shared/models/configuration.ts b/src/shared/models/configuration.ts
@@ -10,7 +10,7 @@ enum BitcoinNetworkName {
   REGTEST = 'regtest',
 }
 
-enum AppEnvironment {
+export enum AppEnvironment {
   MAINNET = 'mainnet',
   TESTNET = 'testnet',
   DEVNET = 'devnet',