Rename contractCallViem to contractCall and reorder return proper…

…ties of `useTransaction`
decentdao · Jun 15, 2024 · f23ca85 · f23ca85
1 parent d7c7f04
commit f23ca85
Show file tree

Hide file tree

Showing 11 changed files with 45 additions and 57 deletions.
diff --git a/src/components/Proposals/MultisigProposalDetails/TxActions.tsx b/src/components/Proposals/MultisigProposalDetails/TxActions.tsx
@@ -49,7 +49,7 @@ export function TxActions({ proposal }: { proposal: MultisigProposal }) {
   const { t } = useTranslation(['proposal', 'common', 'transaction']);
 
   const [asyncRequest, asyncRequestPending] = useAsyncRequest();
-  const [contractCallPending, contractCallViem] = useTransaction();
+  const [contractCall, contractCallPending] = useTransaction();
   const { loadSafeMultisigProposals } = useSafeMultisigProposals();
   const { data: walletClient } = useWalletClient();
 
@@ -125,7 +125,7 @@ export function TxActions({ proposal }: { proposal: MultisigProposal }) {
         address: getAddress(freezeGuardContractAddress),
         client: walletClient,
       });
-      contractCallViem({
+      contractCall({
         contractFn: () =>
           freezeGuard.write.timelockTransaction([
             safeTx.to,
@@ -191,7 +191,7 @@ export function TxActions({ proposal }: { proposal: MultisigProposal }) {
         }),
       );
 
-      contractCallViem({
+      contractCall({
         contractFn: () =>
           safeContract.write.execTransaction([
             safeTx.to,

diff --git a/src/components/pages/DaoDashboard/ERC20Claim.tsx b/src/components/pages/DaoDashboard/ERC20Claim.tsx
@@ -19,7 +19,7 @@ export function ERCO20Claim() {
   const account = user.address;
   const { tokenClaimContractAddress, type } = governance;
   const { t } = useTranslation(['dashboard', 'transaction']);
-  const [pending, contractCallViem] = useTransaction();
+  const [contractCall, pending] = useTransaction();
   const azoriusGovernance = governance as AzoriusGovernance;
   const publicClient = usePublicClient();
   const { data: walletClient } = useWalletClient();
@@ -56,7 +56,7 @@ export function ERCO20Claim() {
       address: tokenClaimContractAddress,
       client: walletClient,
     });
-    contractCallViem({
+    contractCall({
       contractFn: () => tokenClaimContract.write.claimTokens([getAddress(account)]),
       pendingMessage: t('pendingTokenClaim', {
         symbol: azoriusGovernance.votesToken.symbol,

diff --git a/src/components/ui/modals/DelegateModal.tsx b/src/components/ui/modals/DelegateModal.tsx
@@ -34,7 +34,7 @@ export function DelegateModal({ close }: { close: Function }) {
   const decentGovernance = azoriusGovernance as DecentGovernance;
   const delegateeDisplayName = useDisplayName(azoriusGovernance?.votesToken?.delegatee);
   const lockedDelegateeDisplayName = useDisplayName(decentGovernance?.lockedVotesToken?.delegatee);
-  const [contractCallPendingViem, contractCallViem] = useTransaction();
+  const [contractCall, pending] = useTransaction();
   const { addressValidationTest } = useValidationAddress();
   const { data: walletClient } = useWalletClient();
 
@@ -51,7 +51,7 @@ export function DelegateModal({ close }: { close: Function }) {
       client: walletClient,
     });
 
-    contractCallViem({
+    contractCall({
       contractFn: () => votingTokenContract.write.delegate([validAddress]),
       pendingMessage: t('pendingDelegateVote'),
       failedMessage: t('failedDelegateVote'),
@@ -74,7 +74,7 @@ export function DelegateModal({ close }: { close: Function }) {
       client: walletClient,
     });
 
-    contractCallViem({
+    contractCall({
       contractFn: () => lockReleaseContract.write.delegate([getAddress(validAddress)]),
       pendingMessage: t('pendingDelegateVote'),
       failedMessage: t('failedDelegateVote'),
@@ -225,7 +225,7 @@ export function DelegateModal({ close }: { close: Function }) {
               width="100%"
               isDisabled={
                 !!errors.address ||
-                contractCallPendingViem ||
+                pending ||
                 !values.address ||
                 values.address === azoriusGovernance.votesToken?.delegatee
               }
@@ -240,7 +240,7 @@ export function DelegateModal({ close }: { close: Function }) {
                   onClick={() => submitLockedDelegation({ address: values.address })}
                   isDisabled={
                     !!errors.address ||
-                    contractCallPendingViem ||
+                    pending ||
                     !values.address ||
                     values.address === decentGovernance.lockedVotesToken.delegatee
                   }

diff --git a/src/components/ui/modals/UnwrapToken.tsx b/src/components/ui/modals/UnwrapToken.tsx
@@ -22,7 +22,7 @@ export function UnwrapToken({ close }: { close: () => void }) {
   const { address: account } = useAccount();
   const { loadERC20TokenAccountData } = useERC20LinearToken({ onMount: false });
 
-  const [pending, contractCallViem] = useTransaction();
+  const [contractCall, pending] = useTransaction();
   const {
     approved,
     approveTransaction,
@@ -48,7 +48,7 @@ export function UnwrapToken({ close }: { close: () => void }) {
         client: walletClient,
       });
 
-      contractCallViem({
+      contractCall({
         contractFn: () => wrapperTokenContract.write.withdrawTo([account, amount.bigintValue!]),
         pendingMessage: t('unwrapTokenPendingMessage'),
         failedMessage: t('unwrapTokenFailedMessage'),
@@ -61,15 +61,7 @@ export function UnwrapToken({ close }: { close: () => void }) {
         },
       });
     },
-    [
-      account,
-      contractCallViem,
-      governanceContracts,
-      walletClient,
-      close,
-      t,
-      loadERC20TokenAccountData,
-    ],
+    [account, contractCall, governanceContracts, walletClient, close, t, loadERC20TokenAccountData],
   );
 
   if (

diff --git a/src/components/ui/modals/WrapToken.tsx b/src/components/ui/modals/WrapToken.tsx
@@ -31,7 +31,7 @@ export function WrapToken({ close }: { close: () => void }) {
   });
 
   const { loadERC20TokenAccountData } = useERC20LinearToken({ onMount: false });
-  const [pending, contractCallViem] = useTransaction();
+  const [contractCall, pending] = useTransaction();
   const {
     approved,
     approveTransaction,
@@ -93,7 +93,7 @@ export function WrapToken({ close }: { close: () => void }) {
         client: walletClient,
       });
 
-      contractCallViem({
+      contractCall({
         contractFn: () => wrapperTokenContract.write.depositFor([account, amount.bigintValue!]),
         pendingMessage: t('wrapTokenPendingMessage'),
         failedMessage: t('wrapTokenFailedMessage'),
@@ -108,7 +108,7 @@ export function WrapToken({ close }: { close: () => void }) {
     },
     [
       account,
-      contractCallViem,
+      contractCall,
       governanceContracts,
       signer,
       close,

diff --git a/src/hooks/DAO/proposal/useCastVote.ts b/src/hooks/DAO/proposal/useCastVote.ts
@@ -54,7 +54,7 @@ const useCastVote = ({
   const azoriusGovernance = useMemo(() => governance as AzoriusGovernance, [governance]);
   const { type } = azoriusGovernance;
 
-  const [contractCallPending, contractCallCastVoteViem] = useTransaction();
+  const [contractCall, pending] = useTransaction();
 
   const { remainingTokenIds, remainingTokenAddresses } = useUserERC721VotingTokens(
     null,
@@ -63,11 +63,9 @@ const useCastVote = ({
   const { getCanVote, getHasVoted } = useVoteContext();
   const { data: walletClient } = useWalletClient();
 
-  useEffect(() => {
-    if (setPending) {
-      setPending(contractCallPending);
-    }
-  }, [setPending, contractCallPending]);
+  if (setPending) {
+    setPending(pending);
+  }
 
   useEffect(() => {
     if (extendedSnapshotProposal) {
@@ -95,7 +93,7 @@ const useCastVote = ({
           address: getAddress(ozLinearVotingContractAddress),
           client: walletClient,
         });
-        contractCallCastVoteViem({
+        contractCall({
           contractFn: () => ozLinearVotingContract.write.vote([Number(proposal.proposalId), vote]),
           pendingMessage: t('pendingCastVote'),
           failedMessage: t('failedCastVote'),
@@ -117,7 +115,7 @@ const useCastVote = ({
           address: getAddress(erc721LinearVotingContractAddress),
           client: walletClient,
         });
-        contractCallCastVoteViem({
+        contractCall({
           contractFn: () =>
             erc721LinearVotingContract.write.vote([
               Number(proposal.proposalId),
@@ -138,7 +136,7 @@ const useCastVote = ({
       }
     },
     [
-      contractCallCastVoteViem,
+      contractCall,
       erc721LinearVotingContractAddress,
       getCanVote,
       getHasVoted,

diff --git a/src/hooks/DAO/proposal/useExecuteProposal.ts b/src/hooks/DAO/proposal/useExecuteProposal.ts
@@ -18,7 +18,7 @@ export default function useExecuteProposal() {
     governanceDispatch: action.dispatch,
   });
   const { data: walletClient } = useWalletClient();
-  const [contractCallPending, contractCallViem] = useTransaction();
+  const [contractCall, pending] = useTransaction();
 
   const executeProposal = useCallback(
     (proposal: FractalProposal) => {
@@ -50,7 +50,7 @@ export default function useExecuteProposal() {
         operations.push(tx.operation);
       });
 
-      contractCallViem({
+      contractCall({
         contractFn: () =>
           azoriusContract.write.executeProposal([
             Number(proposal.proposalId),
@@ -68,11 +68,11 @@ export default function useExecuteProposal() {
         },
       });
     },
-    [azoriusContractAddress, contractCallViem, t, updateProposalState, walletClient],
+    [azoriusContractAddress, contractCall, t, updateProposalState, walletClient],
   );
 
   return {
-    pending: contractCallPending,
+    pending,
     executeProposal,
   };
 }
diff --git a/src/hooks/DAO/useCastFreezeVote.ts b/src/hooks/DAO/useCastFreezeVote.ts
@@ -1,4 +1,4 @@
-import { useCallback, useEffect } from 'react';
+import { useCallback } from 'react';
 import { useTranslation } from 'react-i18next';
 import { getContract, getAddress } from 'viem';
 import { useWalletClient } from 'wagmi';
@@ -15,7 +15,7 @@ const useCastFreezeVote = ({
 }: {
   setPending: React.Dispatch<React.SetStateAction<boolean>>;
 }) => {
-  const [contractCallPending, contractCallCastFreezeViem] = useTransaction();
+  const [contractCall, pending] = useTransaction();
   const {
     guardContracts: { freezeVotingContractAddress, freezeVotingType },
     node: {
@@ -24,9 +24,7 @@ const useCastFreezeVote = ({
   } = useFractal();
   const { getUserERC721VotingTokens } = useUserERC721VotingTokens(null, undefined, false);
 
-  useEffect(() => {
-    setPending(contractCallPending);
-  }, [setPending, contractCallPending]);
+  setPending(pending);
 
   const { t } = useTranslation('transaction');
   const { data: walletClient } = useWalletClient();
@@ -37,7 +35,7 @@ const useCastFreezeVote = ({
     if (freezeVotingType === FreezeVotingType.ERC721) {
       if (!walletClient) return;
 
-      contractCallCastFreezeViem({
+      contractCall({
         contractFn: () => {
           const freezeERC721VotingContract = getContract({
             abi: ERC721FreezeVotingAbi,
@@ -58,7 +56,7 @@ const useCastFreezeVote = ({
     } else if (freezeVotingType === FreezeVotingType.ERC20) {
       if (!walletClient) return;
 
-      contractCallCastFreezeViem({
+      contractCall({
         contractFn: () => {
           const freezeERC20VotingContract = getContract({
             abi: ERC20FreezeVotingAbi,
@@ -74,7 +72,7 @@ const useCastFreezeVote = ({
     } else if (freezeVotingType === FreezeVotingType.MULTISIG) {
       if (!walletClient) return;
 
-      contractCallCastFreezeViem({
+      contractCall({
         contractFn: () => {
           const freezeMultisigVotingContract = getContract({
             abi: MultisigFreezeVotingAbi,
@@ -91,7 +89,7 @@ const useCastFreezeVote = ({
       throw new Error('unknown freezeVotingType');
     }
   }, [
-    contractCallCastFreezeViem,
+    contractCall,
     freezeVotingContractAddress,
     freezeVotingType,
     getUserERC721VotingTokens,

diff --git a/src/hooks/DAO/useDeployDAO.ts b/src/hooks/DAO/useDeployDAO.ts
@@ -9,7 +9,7 @@ import { useTransaction } from '../utils/useTransaction';
 import useBuildDAOTx from './useBuildDAOTx';
 
 const useDeployDAO = () => {
-  const [contractCallPending, contractCallDeployViem] = useTransaction();
+  const [contractCall, pending] = useTransaction();
   const [build] = useBuildDAOTx();
 
   const { t } = useTranslation('transaction');
@@ -48,7 +48,7 @@ const useDeployDAO = () => {
           client: walletClient,
         });
 
-        contractCallDeployViem({
+        contractCall({
           contractFn: () => multiSendCallOnlyContract.write.multiSend([safeTx]),
           pendingMessage: t('pendingDeploySafe'),
           failedMessage: t('failedDeploySafe'),
@@ -59,10 +59,10 @@ const useDeployDAO = () => {
 
       deploy();
     },
-    [addressPrefix, build, contractCallDeployViem, multiSendCallOnly, t, walletClient],
+    [addressPrefix, build, contractCall, multiSendCallOnly, t, walletClient],
   );
 
-  return [deployDao, contractCallPending] as const;
+  return [deployDao, pending] as const;
 };
 
 export default useDeployDAO;
diff --git a/src/hooks/utils/useApproval.tsx b/src/hooks/utils/useApproval.tsx
@@ -9,7 +9,7 @@ const useApproval = (tokenAddress?: string, spenderAddress?: string, userBalance
   const { address: account } = useAccount();
   const [allowance, setAllowance] = useState(0n);
   const [approved, setApproved] = useState(false);
-  const [pending, contractCallViem] = useTransaction();
+  const [contractCall, pending] = useTransaction();
   const { t } = useTranslation('treasury');
   const { data: walletClient } = useWalletClient();
 
@@ -35,7 +35,7 @@ const useApproval = (tokenAddress?: string, spenderAddress?: string, userBalance
   const approveTransaction = useCallback(async () => {
     if (!tokenContract || !account || !spenderAddress) return;
 
-    contractCallViem({
+    contractCall({
       contractFn: () => tokenContract.write.approve([getAddress(spenderAddress), maxUint256]),
       pendingMessage: t('approvalPendingMessage'),
       failedMessage: t('approvalFailedMessage'),
@@ -44,7 +44,7 @@ const useApproval = (tokenAddress?: string, spenderAddress?: string, userBalance
         setApproved(true);
       },
     });
-  }, [account, contractCallViem, tokenContract, spenderAddress, t]);
+  }, [account, contractCall, tokenContract, spenderAddress, t]);
 
   useEffect(() => {
     fetchAllowance();

diff --git a/src/hooks/utils/useTransaction.ts b/src/hooks/utils/useTransaction.ts
@@ -11,7 +11,7 @@ interface ProviderRpcError extends Error {
   data?: any;
 }
 
-interface ContractCallParamsViem {
+interface ContractCallParams {
   contractFn: () => Promise<Hash>;
   pendingMessage: string;
   failedMessage: string;
@@ -26,8 +26,8 @@ const useTransaction = () => {
   const { t } = useTranslation(['transaction', 'common']);
   const publicClient = usePublicClient();
 
-  const contractCallViem = useCallback(
-    (params: ContractCallParamsViem) => {
+  const contractCall = useCallback(
+    (params: ContractCallParams) => {
       if (!publicClient) return;
 
       let toastId: React.ReactText;
@@ -84,7 +84,7 @@ const useTransaction = () => {
     [t, publicClient],
   );
 
-  return [pending, contractCallViem] as const;
+  return [contractCall, pending] as const;
 };
 
 export { useTransaction };