chore: add generics to 2fa fetchers

argentlabs · Mar 31, 2023 · ee03b76 · ee03b76
1 parent 409678a
commit ee03b76
Show file tree

Hide file tree

Showing 10 changed files with 126 additions and 91 deletions.
diff --git a/packages/extension/src/shared/api/fetcher.ts b/packages/extension/src/shared/api/fetcher.ts
@@ -1,9 +1,11 @@
 /** generic json fetcher */
 
-export type Fetcher = (
+import { useAppState } from "../../ui/app.state"
+
+export type Fetcher = <T>(
   input: RequestInfo | URL,
   init?: RequestInit,
-) => Promise<any>
+) => Promise<T>
 
 export interface FetcherError extends Error {
   url?: string
@@ -37,7 +39,10 @@ export const fetcherError = (
   return error
 }
 
-export const fetcher = async (input: RequestInfo | URL, init?: RequestInit) => {
+export const fetcher = async <T>(
+  input: RequestInfo | URL,
+  init?: RequestInit,
+): Promise<T> => {
   const response = await fetch(input, init)
   /** capture text here in the case of json parse failure we can include it in the error */
   const responseText = await response.text()
@@ -64,7 +69,7 @@ export const fetcherWithArgentApiHeadersForNetwork = (
   network: string,
   fetcherImpl: Fetcher = fetcher,
 ) => {
-  const fetcherWithArgentApiHeaders = (
+  const fetcherWithArgentApiHeaders: Fetcher = (
     input: RequestInfo | URL,
     init?: RequestInit,
   ) => {
@@ -80,6 +85,15 @@ export const fetcherWithArgentApiHeadersForNetwork = (
   return fetcherWithArgentApiHeaders
 }
 
+export const fetcherWithArgentApiHeaders = (fetcherImpl: Fetcher = fetcher) => {
+  const { switcherNetworkId } = useAppState.getState()
+  const fetcher = fetcherWithArgentApiHeadersForNetwork(
+    switcherNetworkId,
+    fetcherImpl,
+  )
+  return fetcher
+}
+
 /** convert KnownNetworksType to 'goerli' or 'mainnet' expected by API */
 
 export const argentApiNetworkForNetwork = (network: string) => {

diff --git a/packages/extension/src/shared/shield/backend/account.ts b/packages/extension/src/shared/shield/backend/account.ts
@@ -2,8 +2,10 @@ import {
   Cosigner,
   CosignerMessage,
   CosignerOffchainMessage,
+  CosignerResponse,
 } from "@argent/guardian"
 import retry from "async-retry"
+import urlJoin from "url-join"
 import { z } from "zod"
 
 import { ARGENT_API_BASE_URL } from "../../api/constants"
@@ -18,7 +20,7 @@ export const requestEmailAuthentication = async (
 ) => {
   try {
     const json = await jwtFetcher(
-      `${ARGENT_API_BASE_URL}/account/requestEmailAuthentication`,
+      urlJoin(ARGENT_API_BASE_URL, `account/requestEmailAuthentication`),
       {
         method: "POST",
         body: JSON.stringify({
@@ -42,7 +44,7 @@ const emailVerificationStatus = [
   "notRequested",
 ] as const
 
-export type EmailVerificationStatus = (typeof emailVerificationStatus)[number]
+export type EmailVerificationStatus = typeof emailVerificationStatus[number]
 
 export const emailVerificationStatusErrorSchema = z.object({
   name: z.string(),
@@ -55,17 +57,20 @@ export const emailVerificationStatusErrorSchema = z.object({
   }),
 })
 
-export const getEmailVerificationStatus =
-  async (): Promise<EmailVerificationStatus> => {
-    try {
-      const json = await jwtFetcher(
-        `${ARGENT_API_BASE_URL}/account/emailVerificationStatus`,
-      )
-      return json.status
-    } catch (error) {
-      throw new Error("Failed to get email verification status")
-    }
+export interface GetEmailVerificationStatusReponse {
+  status: EmailVerificationStatus
+}
+
+export const getEmailVerificationStatus = async () => {
+  try {
+    const json = await jwtFetcher<GetEmailVerificationStatusReponse>(
+      urlJoin(ARGENT_API_BASE_URL, `account/emailVerificationStatus`),
+    )
+    return json.status
+  } catch (error) {
+    throw new Error("Failed to get email verification status")
   }
+}
 
 export const getVerificationErrorMessage = (
   status: EmailVerificationStatus,
@@ -84,10 +89,10 @@ export const getVerificationErrorMessage = (
   }
 }
 
-export const register = async (): Promise<void> => {
+export const register = async () => {
   try {
-    const json = await jwtFetcher(
-      `${ARGENT_API_BASE_URL}/account/asyncRegister`,
+    const json = await jwtFetcher<void>(
+      urlJoin(ARGENT_API_BASE_URL, `account/asyncRegister`),
       {
         method: "POST",
         body: JSON.stringify({}),
@@ -125,11 +130,9 @@ interface VerifyEmailResponse {
   userRegistrationStatus: "registered" | "notRegistered"
 }
 
-export const verifyEmail = async (
-  verificationCode: string,
-): Promise<VerifyEmailResponse> => {
-  const json: VerifyEmailResponse = await jwtFetcher(
-    `${ARGENT_API_BASE_URL}/verifyEmail`,
+export const verifyEmail = async (verificationCode: string) => {
+  const json = await jwtFetcher<VerifyEmailResponse>(
+    urlJoin(ARGENT_API_BASE_URL, `verifyEmail`),
     {
       method: "POST",
       body: JSON.stringify({
@@ -142,10 +145,14 @@ export const verifyEmail = async (
 
 type RegistrationStatus = "notFound" | "registering" | "registered" | "failed"
 
-export const getRegistrationStatus = async (): Promise<RegistrationStatus> => {
+interface GetRegistrationStatusResponse {
+  status: RegistrationStatus
+}
+
+export const getRegistrationStatus = async () => {
   try {
-    const json = await jwtFetcher(
-      `${ARGENT_API_BASE_URL}/account/registrationStatus`,
+    const json = await jwtFetcher<GetRegistrationStatusResponse>(
+      urlJoin(ARGENT_API_BASE_URL, `account/registrationStatus`),
     )
     return json.status
   } catch (error) {
@@ -155,7 +162,7 @@ export const getRegistrationStatus = async (): Promise<RegistrationStatus> => {
 
 export const isTokenExpired = async () => {
   try {
-    await jwtFetcher(`${ARGENT_API_BASE_URL}/account`)
+    await jwtFetcher<void>(urlJoin(ARGENT_API_BASE_URL, `account`))
     return false
   } catch (error) {
     IS_DEV && console.warn(coerceErrorToString(error))
@@ -176,10 +183,17 @@ export interface BackendAccount {
   salt: string | null
 }
 
-export const getBackendAccounts = async (): Promise<BackendAccount[]> => {
+interface GetAccountsResponse {
+  accounts: BackendAccount[]
+}
+
+export const getBackendAccounts = async () => {
   try {
-    const json = await jwtFetcher(
-      `${ARGENT_API_BASE_URL}/accounts?application=argentx&chain=starknet`,
+    const json = await jwtFetcher<GetAccountsResponse>(
+      urlJoin(
+        ARGENT_API_BASE_URL,
+        `accounts?application=argentx&chain=starknet`,
+      ),
     )
     return json.accounts
   } catch (error) {
@@ -196,22 +210,25 @@ export const addBackendAccount = async (
   pubKey: string,
   accountAddress: string,
   signature: string[],
-): Promise<AddAccountResponse> => {
+) => {
   try {
-    const json = await jwtFetcher(`${ARGENT_API_BASE_URL}/account`, {
-      method: "POST",
-      body: JSON.stringify({
-        chain: "starknet",
-        application: "argentx",
-        ownerAddress: pubKey,
-        accountAddress,
-        signature: {
-          r: signature[0],
-          s: signature[1],
-        },
-        assignCosigner: true,
-      }),
-    })
+    const json = await jwtFetcher<AddAccountResponse>(
+      urlJoin(ARGENT_API_BASE_URL, `account`),
+      {
+        method: "POST",
+        body: JSON.stringify({
+          chain: "starknet",
+          application: "argentx",
+          ownerAddress: pubKey,
+          accountAddress,
+          signature: {
+            r: signature[0],
+            s: signature[1],
+          },
+          assignCosigner: true,
+        }),
+      },
+    )
     return json
   } catch (error) {
     throw new Error("Failed to add account")
@@ -223,14 +240,17 @@ export const cosignerSign: Cosigner = async (
   isOffchainMessage = false,
 ) => {
   const beEndpoint = isOffchainMessage
-    ? "/cosigner/personalSign"
-    : `/cosigner/sign`
+    ? "cosigner/personalSign"
+    : `cosigner/sign`
 
   try {
-    const json = await jwtFetcher(`${ARGENT_API_BASE_URL}${beEndpoint}`, {
-      method: "POST",
-      body: JSON.stringify(message),
-    })
+    const json = await jwtFetcher<CosignerResponse>(
+      urlJoin(ARGENT_API_BASE_URL, beEndpoint),
+      {
+        method: "POST",
+        body: JSON.stringify(message),
+      },
+    )
     return json
   } catch (error) {
     if (isFetcherError(error) && error.responseJson?.status) {

diff --git a/packages/extension/src/shared/shield/jwtFetcher.ts b/packages/extension/src/shared/shield/jwtFetcher.ts
@@ -1,12 +1,11 @@
-import { useAppState } from "../../ui/app.state"
-import { fetcherWithArgentApiHeadersForNetwork } from "../api/fetcher"
+import { fetcherWithArgentApiHeaders } from "../api/fetcher"
 import { IS_DEV } from "../utils/dev"
 import { coerceErrorToString } from "../utils/error"
 import { generateJwt } from "./jwt"
 
 /** wraps fetcher, generates and uses bearer jwt */
 
-export const jwtFetcher = async (
+export const jwtFetcher = async <T>(
   input: RequestInfo | URL,
   init?: RequestInit,
 ) => {
@@ -19,10 +18,9 @@ export const jwtFetcher = async (
       "Content-Type": "application/json",
     },
   }
-  const { switcherNetworkId } = useAppState.getState()
-  const fetcher = fetcherWithArgentApiHeadersForNetwork(switcherNetworkId)
+  const fetcher = fetcherWithArgentApiHeaders()
   try {
-    return fetcher(input, initWithArgentJwtHeaders)
+    return fetcher<T>(input, initWithArgentJwtHeaders)
   } catch (error) {
     IS_DEV && console.warn(coerceErrorToString(error))
     throw error

diff --git a/packages/extension/src/shared/transactionReview.service.ts b/packages/extension/src/shared/transactionReview.service.ts
@@ -53,7 +53,7 @@ export const apiTransactionReviewActivityType = [
 ] as const
 
 export type ApiTransactionReviewActivityType =
-  (typeof apiTransactionReviewActivityType)[number]
+  typeof apiTransactionReviewActivityType[number]
 
 export type TransactionReviewWithType = ApiTransactionReview & {
   type: ApiTransactionReviewActivityType
@@ -145,14 +145,17 @@ export const fetchTransactionReview = ({
     account: accountAddress,
     calls,
   }
-  return fetcherImpl(ARGENT_TRANSACTION_REVIEW_STARKNET_URL, {
-    method: "POST",
-    headers: {
-      Accept: "application/json",
-      "Content-Type": "application/json",
+  return fetcherImpl<ApiTransactionReviewResponse>(
+    ARGENT_TRANSACTION_REVIEW_STARKNET_URL,
+    {
+      method: "POST",
+      headers: {
+        Accept: "application/json",
+        "Content-Type": "application/json",
+      },
+      body: JSON.stringify(body),
     },
-    body: JSON.stringify(body),
-  })
+  )
 }
 
 export const getDisplayWarnAndReasonForTransactionReview = (

diff --git a/packages/extension/src/shared/transactionSimulation/transactionSimulation.service.ts b/packages/extension/src/shared/transactionSimulation/transactionSimulation.service.ts
@@ -4,7 +4,8 @@ import { ARGENT_TRANSACTION_SIMULATION_URL } from "../api/constants"
 import { fetcher } from "../api/fetcher"
 import { sendMessage, waitForMessage } from "../messages"
 import { findTransfersAndApprovals } from "./findTransferAndApproval"
-import type {
+import {
+  ApiTransactionSimulationResponse,
   IFetchTransactionSimulation,
   TransactionSimulationApproval,
   TransactionSimulationTransfer,
@@ -35,20 +36,21 @@ export const fetchTransactionSimulation = async ({
   try {
     const { invocation, chainId } = data
 
-    const backendSimulation = await fetcherImpl(
-      ARGENT_TRANSACTION_SIMULATION_URL,
-      {
-        method: "POST",
-        headers: {
-          Accept: "application/json",
-          "Content-Type": "application/json",
+    const backendSimulation =
+      await fetcherImpl<ApiTransactionSimulationResponse>(
+        ARGENT_TRANSACTION_SIMULATION_URL,
+        {
+          method: "POST",
+          headers: {
+            Accept: "application/json",
+            "Content-Type": "application/json",
+          },
+          body: JSON.stringify({
+            ...invocation,
+            chainId,
+          }),
         },
-        body: JSON.stringify({
-          ...invocation,
-          chainId,
-        }),
-      },
-    )
+      )
     return backendSimulation
   } catch (e) {
     console.error("Failed to fetch transaction simulation from backend", e)

diff --git a/packages/extension/src/ui/features/actions/transaction/useTransactionReview.ts b/packages/extension/src/ui/features/actions/transaction/useTransactionReview.ts
@@ -8,10 +8,7 @@ import {
   settingsStore,
 } from "../../../../shared/settings"
 import { useKeyValueStorage } from "../../../../shared/storage/hooks"
-import {
-  ApiTransactionReviewResponse,
-  fetchTransactionReview,
-} from "../../../../shared/transactionReview.service"
+import { fetchTransactionReview } from "../../../../shared/transactionReview.service"
 import { argentApiFetcher } from "../../../services/argentApiFetcher"
 import { useConditionallyEnabledSWR } from "../../../services/swr"
 import { Account } from "../../accounts/Account"
@@ -59,7 +56,7 @@ export const useTransactionReview = ({
     })
     // TODO: come back - dont rerender when fetcher reference changes
   }, [account, transactions]) // eslint-disable-line react-hooks/exhaustive-deps
-  return useConditionallyEnabledSWR<ApiTransactionReviewResponse>(
+  return useConditionallyEnabledSWR(
     Boolean(transactionReviewEnabled),
     [actionHash, "transactionReview"],
     transactionReviewFetcher,

diff --git a/packages/extension/src/ui/features/actions/transaction/useTransactionSimulation.ts b/packages/extension/src/ui/features/actions/transaction/useTransactionSimulation.ts
@@ -8,7 +8,6 @@ import {
 } from "../../../../shared/settings"
 import { useKeyValueStorage } from "../../../../shared/storage/hooks"
 import { fetchTransactionSimulation } from "../../../../shared/transactionSimulation/transactionSimulation.service"
-import { ApiTransactionSimulationResponse } from "../../../../shared/transactionSimulation/types"
 import { argentApiFetcher } from "../../../services/argentApiFetcher"
 import { useConditionallyEnabledSWR } from "../../../services/swr"
 import { Account } from "../../accounts/Account"
@@ -50,7 +49,7 @@ export const useTransactionSimulation = ({
       fetcher: argentApiFetcher,
     })
   }, [account, transactions]) // eslint-disable-line react-hooks/exhaustive-deps
-  return useConditionallyEnabledSWR<ApiTransactionSimulationResponse>(
+  return useConditionallyEnabledSWR(
     Boolean(transactionSimulationEnabled),
     [actionHash, "transactionSimulation"],
     transactionSimulationFetcher,