Merge pull request #825 from kleros/feat(web)/add-function-return-types

alcercu · web-flow · commit 2861d391aac0 · 2023-06-08T10:52:46.000+02:00
feat: add return types for functions
diff --git a/web/src/components/DisputeCard/DisputeInfo.tsx b/web/src/components/DisputeCard/DisputeInfo.tsx
@@ -1,10 +1,10 @@
 import React from "react";
 import styled from "styled-components";
 import { Periods } from "consts/periods";
-import LawBalanceIcon from "svgs/icons/law-balance.svg";
 import BookmarkIcon from "svgs/icons/bookmark.svg";
-import PileCoinsIcon from "svgs/icons/pile-coins.svg";
 import CalendarIcon from "svgs/icons/calendar.svg";
+import LawBalanceIcon from "svgs/icons/law-balance.svg";
+import PileCoinsIcon from "svgs/icons/pile-coins.svg";
 import Field from "../Field";
 
 const Container = styled.div`
@@ -13,7 +13,7 @@ const Container = styled.div`
   gap: 8px;
 `;
 
-const getPeriodPhrase = (period: Periods) => {
+const getPeriodPhrase = (period: Periods): string => {
   switch (period) {
     case Periods.evidence:
       return "Voting Starts";
@@ -35,36 +35,14 @@ export interface IDisputeInfo {
   date?: number;
 }
 
-const DisputeInfo: React.FC<IDisputeInfo> = ({
-  courtId,
-  court,
-  category,
-  rewards,
-  period,
-  date,
-}) => {
+const DisputeInfo: React.FC<IDisputeInfo> = ({ courtId, court, category, rewards, period, date }) => {
   return (
     <Container>
-      {category && (
-        <Field icon={BookmarkIcon} name="Category" value={category} />
-      )}
-      {court && courtId && (
-        <Field
-          icon={LawBalanceIcon}
-          name="Court"
-          value={court}
-          link={`/courts/${courtId}`}
-        />
-      )}
-      {rewards && (
-        <Field icon={PileCoinsIcon} name="Juror Rewards" value={rewards} />
-      )}
+      {category && <Field icon={BookmarkIcon} name="Category" value={category} />}
+      {court && courtId && <Field icon={LawBalanceIcon} name="Court" value={court} link={`/courts/${courtId}`} />}
+      {rewards && <Field icon={PileCoinsIcon} name="Juror Rewards" value={rewards} />}
       {typeof period !== "undefined" && date && (
-        <Field
-          icon={CalendarIcon}
-          name={getPeriodPhrase(period)}
-          value={new Date(date * 1000).toLocaleString()}
-        />
+        <Field icon={CalendarIcon} name={getPeriodPhrase(period)} value={new Date(date * 1000).toLocaleString()} />
       )}
     </Container>
   );
diff --git a/web/src/components/DisputeCard/PeriodBanner.tsx b/web/src/components/DisputeCard/PeriodBanner.tsx
@@ -54,7 +54,7 @@ const Container = styled.div<Omit<IPeriodBanner, "id">>`
   }};
 `;
 
-const getPeriodLabel = (period: Periods) => {
+const getPeriodLabel = (period: Periods): string => {
   switch (period) {
     case Periods.appeal:
       return "Crowdfunding Appeal";
diff --git a/web/src/hooks/queries/useCasesQuery.ts b/web/src/hooks/queries/useCasesQuery.ts
@@ -5,12 +5,7 @@ export type { CasesPageQuery };
 
 const casesQuery = gql`
   query CasesPage($skip: Int) {
-    disputes(
-      first: 3
-      skip: $skip
-      orderBy: lastPeriodChange
-      orderDirection: desc
-    ) {
+    disputes(first: 3, skip: $skip, orderBy: lastPeriodChange, orderDirection: desc) {
       id
       arbitrated {
         id
@@ -30,7 +25,7 @@ const casesQuery = gql`
   }
 `;
 
-export const useCasesQuery = (skip: number) => {
+export const useCasesQuery = (skip: number): { data: typeof result; error: any; isValidating: boolean } => {
   const { data, error, isValidating } = useSWR({
     query: casesQuery,
     variables: { skip: skip },
diff --git a/web/src/hooks/queries/useClassicAppealQuery.ts b/web/src/hooks/queries/useClassicAppealQuery.ts
@@ -29,7 +29,9 @@ const classicAppealQuery = gql`
   }
 `;
 
-export const useClassicAppealQuery = (id?: string | number) => {
+export const useClassicAppealQuery = (
+  id?: string | number
+): { data: typeof result; error: any; isValidating: boolean } => {
   const { data, error, isValidating } = useSWR(() =>
     typeof id !== "undefined"
       ? {
diff --git a/web/src/hooks/queries/useCourtDetails.ts b/web/src/hooks/queries/useCourtDetails.ts
@@ -18,7 +18,7 @@ const courtDetailsQuery = gql`
   }
 `;
 
-export const useCourtDetails = (id?: string) => {
+export const useCourtDetails = (id?: string): { data: typeof result; error: any; isValidating: boolean } => {
   const { data, error, isValidating } = useSWR(
     id
       ? {
diff --git a/web/src/hooks/queries/useCourtPolicyURI.ts b/web/src/hooks/queries/useCourtPolicyURI.ts
@@ -11,7 +11,7 @@ const courtPolicyURIQuery = gql`
   }
 `;
 
-export const useCourtPolicyURI = (id?: string | number) => {
+export const useCourtPolicyURI = (id?: string | number): { data: typeof result; error: any; isValidating: boolean } => {
   const { data, error, isValidating } = useSWRImmutable(() =>
     typeof id !== "undefined"
       ? {
@@ -20,8 +20,6 @@ export const useCourtPolicyURI = (id?: string | number) => {
         }
       : false
   );
-  const result = data
-    ? (data.court.policy as CourtPolicyUriQuery.court.policy)
-    : undefined;
+  const result = data ? (data.court.policy as CourtPolicyUriQuery.court.policy) : undefined;
   return { data: result, error, isValidating };
 };
diff --git a/web/src/hooks/queries/useCourtTree.ts b/web/src/hooks/queries/useCourtTree.ts
@@ -32,7 +32,7 @@ const courtTreeQuery = gql`
   }
 `;
 
-export const useCourtTree = () => {
+export const useCourtTree = (): { data: typeof result; error: any; isValidating: boolean } => {
   const { data, error, isValidating } = useSWR({
     query: courtTreeQuery,
   });
diff --git a/web/src/hooks/queries/useDisputeDetailsQuery.ts b/web/src/hooks/queries/useDisputeDetailsQuery.ts
@@ -22,7 +22,9 @@ const disputeDetailsQuery = gql`
   }
 `;
 
-export const useDisputeDetailsQuery = (id?: string | number) => {
+export const useDisputeDetailsQuery = (
+  id?: string | number
+): { data: typeof result; error: any; isValidating: boolean } => {
   const { data, error, isValidating } = useSWR(() =>
     typeof id !== "undefined"
       ? {
diff --git a/web/src/hooks/queries/useDisputeKitClassicMultipliers.ts b/web/src/hooks/queries/useDisputeKitClassicMultipliers.ts
@@ -8,12 +8,9 @@ export const useDisputeKitClassicMultipliers = () => {
     () => (disputeKitClassic ? `Multipliers` : false),
     async () => {
       if (!disputeKitClassic) return;
-      const winner_stake_multiplier =
-        await disputeKitClassic.WINNER_STAKE_MULTIPLIER();
-      const loser_stake_multiplier =
-        await disputeKitClassic.LOSER_STAKE_MULTIPLIER();
-      const loser_appeal_period_multiplier =
-        await disputeKitClassic.LOSER_APPEAL_PERIOD_MULTIPLIER();
+      const winner_stake_multiplier = await disputeKitClassic.WINNER_STAKE_MULTIPLIER();
+      const loser_stake_multiplier = await disputeKitClassic.LOSER_STAKE_MULTIPLIER();
+      const loser_appeal_period_multiplier = await disputeKitClassic.LOSER_APPEAL_PERIOD_MULTIPLIER();
       return {
         winner_stake_multiplier,
         loser_stake_multiplier,
diff --git a/web/src/hooks/queries/useDrawQuery.ts b/web/src/hooks/queries/useDrawQuery.ts
@@ -11,7 +11,10 @@ const drawQuery = gql`
   }
 `;
 
-export const useDrawQuery = (address?: string | null, disputeID?: string) => {
+export const useDrawQuery = (
+  address?: string | null,
+  disputeID?: string
+): { data: typeof result; error: any; isValidating: boolean } => {
   const { data, error, isValidating } = useSWR({
     query: drawQuery,
     variables: { address, disputeID },
diff --git a/web/src/hooks/queries/useEvidences.ts b/web/src/hooks/queries/useEvidences.ts
@@ -5,11 +5,7 @@ export type { EvidencesQuery };
 
 const evidencesQuery = gql`
   query Evidences($evidenceGroup: String) {
-    evidences(
-      where: { evidenceGroup: $evidenceGroup }
-      orderBy: id
-      orderDirection: asc
-    ) {
+    evidences(where: { evidenceGroup: $evidenceGroup }, orderBy: id, orderDirection: asc) {
       id
       evidence
       sender {
@@ -19,7 +15,7 @@ const evidencesQuery = gql`
   }
 `;
 
-export const useEvidences = (evidenceGroup?: string) => {
+export const useEvidences = (evidenceGroup?: string): { data: typeof result; error: any; isValidating: boolean } => {
   const { data, error, isValidating } = useSWR(() =>
     typeof evidenceGroup !== "undefined"
       ? {
diff --git a/web/src/hooks/queries/useHomePageQuery.ts b/web/src/hooks/queries/useHomePageQuery.ts
@@ -19,7 +19,7 @@ const homePageQuery = gql`
   }
 `;
 
-export const useHomePageQuery = (timeframe: number) => {
+export const useHomePageQuery = (timeframe: number): { data: typeof result; error: any; isValidating: boolean } => {
   const { data, error, isValidating } = useSWR({
     query: homePageQuery,
     variables: { timeframe: timeframe.toString() },
diff --git a/web/src/hooks/queries/useJurorBalance.ts b/web/src/hooks/queries/useJurorBalance.ts
@@ -2,14 +2,10 @@ import useSWR from "swr";
 import { KlerosCore } from "@kleros/kleros-v2-contracts/typechain-types/src/arbitration/KlerosCore";
 import { useConnectedContract } from "../useConnectedContract";
 
-export const useJurorBalance = (
-  user?: string | null,
-  courtId?: string | undefined
-) => {
+export const useJurorBalance = (user?: string | null, courtId?: string | undefined) => {
   const klerosCore = useConnectedContract("KlerosCore") as KlerosCore;
   return useSWR(
-    () =>
-      klerosCore && user && courtId ? `JurorBalance{address}{courtId}` : false,
+    () => (klerosCore && user && courtId ? `JurorBalance${user}${courtId}` : false),
     async () => {
       if (klerosCore && user && courtId) {
         return await klerosCore.getJurorBalance(user, courtId);
diff --git a/web/src/hooks/queries/usePNKAllowance.ts b/web/src/hooks/queries/usePNKAllowance.ts
@@ -6,13 +6,10 @@ import { CONTRACTS } from "utils/getContract";
 export const usePNKAllowance = (user?: string | null) => {
   const pnkContract = useConnectedContract("PNK") as PNK;
   return useSWR(
-    () => (pnkContract && user ? `PNKAllowance{user}` : false),
+    () => (pnkContract && user ? `PNKAllowance${user}` : false),
     async () => {
       if (pnkContract && user) {
-        return await pnkContract.allowance(
-          user,
-          CONTRACTS["KlerosCore"].address
-        );
+        return await pnkContract.allowance(user, CONTRACTS["KlerosCore"].address);
       } else {
         return undefined;
       }
diff --git a/web/src/hooks/queries/useVotingHistory.ts b/web/src/hooks/queries/useVotingHistory.ts
@@ -31,7 +31,7 @@ const votingHistoryQuery = gql`
   }
 `;
 
-export const useVotingHistory = (disputeID?: string) => {
+export const useVotingHistory = (disputeID?: string): { data: typeof result; error: any; isValidating: boolean } => {
   const { data, error, isValidating } = useSWR(() =>
     typeof disputeID !== "undefined"
       ? {
diff --git a/web/src/hooks/useParsedAmount.ts b/web/src/hooks/useParsedAmount.ts
@@ -1,9 +1,6 @@
 import { useMemo } from "react";
 import { BigNumber, utils } from "ethers";
 
-export function useParsedAmount(amount: string) {
-  return useMemo(
-    () => (amount === "" ? BigNumber.from(0) : utils.parseUnits(amount, 18)),
-    [amount]
-  );
+export function useParsedAmount(amount: string): BigNumber {
+  return useMemo(() => (amount === "" ? BigNumber.from(0) : utils.parseUnits(amount, 18)), [amount]);
 }
diff --git a/web/src/pages/Cases/CaseDetails/Evidence/SubmitEvidenceModal.tsx b/web/src/pages/Cases/CaseDetails/Evidence/SubmitEvidenceModal.tsx
@@ -1,9 +1,9 @@
 import React, { useState } from "react";
 import styled from "styled-components";
 import Modal from "react-modal";
-import { Textarea, Button } from "@kleros/ui-components-library";
-import { DisputeKitClassic } from "@kleros/kleros-v2-contracts/typechain-types/src/arbitration/dispute-kits/DisputeKitClassic";
 import { wrapWithToast } from "utils/wrapWithToast";
+import { Button, Textarea } from "@kleros/ui-components-library";
+import { DisputeKitClassic } from "@kleros/kleros-v2-contracts/typechain-types/src/arbitration/dispute-kits/DisputeKitClassic";
 import { useConnectedContract } from "hooks/useConnectedContract";
 import { uploadFormDataToIPFS } from "utils/uploadFormDataToIPFS";
 
@@ -12,26 +12,15 @@ const SubmitEvidenceModal: React.FC<{
   evidenceGroup: string;
   close: () => void;
 }> = ({ isOpen, evidenceGroup, close }) => {
-  const disputeKit = useConnectedContract(
-    "DisputeKitClassic"
-  ) as DisputeKitClassic;
+  const disputeKit = useConnectedContract("DisputeKitClassic") as DisputeKitClassic;
   const [isSending, setIsSending] = useState(false);
   const [message, setMessage] = useState("");
   return (
     <StyledModal {...{ isOpen }}>
       <h1>Submit New Evidence</h1>
-      <StyledTextArea
-        value={message}
-        onChange={(e) => setMessage(e.target.value)}
-        placeholder="Your Arguments"
-      />
+      <StyledTextArea value={message} onChange={(e) => setMessage(e.target.value)} placeholder="Your Arguments" />
       <ButtonArea>
-        <Button
-          variant="secondary"
-          disabled={isSending}
-          text="Return"
-          onClick={close}
-        />
+        <Button variant="secondary" disabled={isSending} text="Return" onClick={close} />
         <Button
           text="Submit"
           isLoading={isSending}
@@ -44,9 +33,7 @@ const SubmitEvidenceModal: React.FC<{
                 const response = await res.json();
                 if (res.status === 200) {
                   const cid = "/ipfs/" + response["cid"];
-                  await wrapWithToast(
-                    disputeKit.submitEvidence(evidenceGroup, cid)
-                  ).then(() => {
+                  await wrapWithToast(disputeKit.submitEvidence(evidenceGroup, cid)).then(() => {
                     setMessage("");
                     close();
                   });
@@ -61,13 +48,11 @@ const SubmitEvidenceModal: React.FC<{
   );
 };
 
-const constructEvidence = (msg: string) => {
+const constructEvidence = (msg: string): FormData => {
   const formData = new FormData();
-  const file = new File(
-    [JSON.stringify({ name: "Evidence", description: msg })],
-    "evidence.json",
-    { type: "text/plain" }
-  );
+  const file = new File([JSON.stringify({ name: "Evidence", description: msg })], "evidence.json", {
+    type: "text/plain",
+  });
   formData.append("data", file, file.name);
   return formData;
 };
diff --git a/web/src/pages/Courts/CourtDetails/StakePanel/JurorStakeDisplay.tsx b/web/src/pages/Courts/CourtDetails/StakePanel/JurorStakeDisplay.tsx
@@ -2,17 +2,14 @@ import React from "react";
 import styled from "styled-components";
 import { useParams } from "react-router-dom";
 import { BigNumber, utils } from "ethers";
-
 import { useJurorBalance } from "queries/useJurorBalance";
 import { useWeb3 } from "hooks/useWeb3";
-
 import Field from "components/Field";
-import PNKIcon from "svgs/icons/pnk.svg";
-import LockerIcon from "svgs/icons/locker.svg";
 import DiceIcon from "svgs/icons/dice.svg";
+import LockerIcon from "svgs/icons/locker.svg";
+import PNKIcon from "svgs/icons/pnk.svg";
 
-const format = (value: BigNumber | undefined) =>
-  value !== undefined ? utils.formatEther(value) : "0";
+const format = (value: BigNumber | undefined): string => (value !== undefined ? utils.formatEther(value) : "0");
 
 const JurorBalanceDisplay = () => {
   const { id } = useParams();
diff --git a/web/src/utils/date.ts b/web/src/utils/date.ts
@@ -1,4 +1,4 @@
-export function getCurrentTime() {
+export function getCurrentTime(): number {
   return Math.floor(Date.now() / 1000);
 }
 

Original file line number	Diff line number	Diff line change
@@ -18,7 +18,7 @@ const courtDetailsQuery = gql`
`18`	`18`	`}`
`19`	`19`	`;
`20`	`20`
`21`		`-export const useCourtDetails = (id?: string) => {`
	`21`	`+export const useCourtDetails = (id?: string): { data: typeof result; error: any; isValidating: boolean } => {`
`22`	`22`	`const { data, error, isValidating } = useSWR(`
`23`	`23`	`id`
`24`	`24`	`? {`
Original file line number	Diff line number	Diff line change
@@ -32,7 +32,7 @@ const courtTreeQuery = gql`
`32`	`32`	`}`
`33`	`33`	`;
`34`	`34`
`35`		`-export const useCourtTree = () => {`
	`35`	`+export const useCourtTree = (): { data: typeof result; error: any; isValidating: boolean } => {`
`36`	`36`	`const { data, error, isValidating } = useSWR({`
`37`	`37`	`query: courtTreeQuery,`
`38`	`38`	`});`