Merge pull request #156 from valory-xyz/tanya/revoke

feat: implement revoking power

Author: Tanya-atatakai

apps/govern/common-util/constants/scopeKeys.ts

@@ -14,7 +14,7 @@ export const INVALIDATE_AFTER_UPDATE_KEYS = [
   TIME_SUM_KEY,
 ];
 
-export const INVALIDATE_AFTER_ACCOUNT_CHANGE = [
+export const INVALIDATE_AFTER_USER_DATA_CHANGE = [
   LAST_USER_VOTE_KEY,
   VOTE_USER_POWER_KEY,
   NEXT_USERS_SLOPES_KEY,

apps/govern/common-util/functions/addresses.ts

@@ -1,4 +1,3 @@
-export * from './addresses';
 export * from './frontend-library';
 export * from './requests';
 export * from './web3';

apps/govern/common-util/functions/index.ts

@@ -1,7 +1,7 @@
 import { AbiCoder, ethers } from 'ethers';
 import { Address } from 'viem';
 
-export const getNomineeHash = (account: Address, chainId: number) => {
+export const getNomineeHash = (account: Address | string, chainId: number) => {
   const nomineeEncoded = AbiCoder.defaultAbiCoder().encode(
     ['bytes32', 'uint256'],
     [account, chainId],

apps/govern/common-util/functions/nominee-hash.ts

@@ -9,11 +9,14 @@ import {
   STAKING_FACTORY,
   VE_OLAS,
 } from 'libs/util-contracts/src/lib/abiAndAddresses';
-import { getEstimatedGasLimit, sendTransaction } from 'libs/util-functions/src';
+import {
+  getAddressFromBytes32,
+  getEstimatedGasLimit,
+  sendTransaction,
+} from 'libs/util-functions/src';
 
 import { SUPPORTED_CHAINS, wagmiConfig } from 'common-util/config/wagmi';
 
-import { getAddressFromBytes32 } from './addresses';
 import { getUnixNextWeekStartTimestamp } from './time';
 import {
   getGovernorContract,
@@ -24,6 +27,7 @@ import {
   getVoteWeightingContract,
 } from './web3';
 import { RPC_URLS } from 'libs/util-constants/src';
+import { Nominee } from 'types';
 
 type VoteForNomineeWeightsParams = {
   account: Address | undefined;
@@ -54,9 +58,7 @@ export const voteForNomineeWeights = async ({
 
 export const checkIfNomineeRemoved = async (allocations: { address: Address }[]) => {
   const contract = getVoteWeightingContract();
-  const result: { account: Address; chainId: number }[] = await contract.methods
-    .getAllRemovedNominees()
-    .call();
+  const result: Nominee[] = await contract.methods.getAllRemovedNominees().call();
 
   if (!result) return [];
 
@@ -415,3 +417,27 @@ export const voteForProposal = async ({
 
   return result;
 };
+
+/**
+ * Revoke voting power from a removed nominee
+ */
+type RevokePowerParams = {
+  account: Address | undefined;
+  nominee: string;
+  chainId: number;
+};
+
+export const revokePower = async ({ account, nominee, chainId }: RevokePowerParams) => {
+  const contract = getVoteWeightingContract();
+  const voteFn = contract.methods.revokeRemovedNomineeVotingPower(nominee, chainId);
+
+  const estimatedGas = await getEstimatedGasLimit(voteFn, account);
+  const fn = voteFn.send({ from: account, estimatedGas });
+
+  const result = await sendTransaction(fn, account, {
+    supportedChains: SUPPORTED_CHAINS,
+    rpcUrls: RPC_URLS,
+  });
+
+  return result;
+};

apps/govern/common-util/functions/requests.ts

@@ -0,0 +1,23 @@
+import { ActionCreatorWithoutPayload } from '@reduxjs/toolkit';
+import { queryClient } from 'context/Web3ModalProvider';
+import { clearState } from 'store/govern';
+import { AppDispatch } from 'store/index';
+
+// Reset previously saved data so it's re-fetched automatically
+export const resetState = (
+  keys: string[],
+  dispatch: AppDispatch,
+  clearAction: ActionCreatorWithoutPayload<
+    'govern/clearState' | 'govern/clearUserState'
+  > = clearState,
+) => {
+  queryClient.removeQueries({
+    predicate: (query) =>
+      keys.includes(
+        // `query.queryKey[0]` is just the name of the function that initiate the query cache, e.g "readContract"
+        // while `query.queryKey[1]` has query arguments, including scopeKey if provided
+        (query.queryKey[1] as Record<string, string>)?.scopeKey,
+      ),
+  });
+  dispatch(clearAction());
+};

apps/govern/common-util/functions/resetState.ts

@@ -8,11 +8,11 @@ import { useEnsName } from 'wagmi';
 
 import { CHAIN_NAMES, EXPLORER_URLS, UNICODE_SYMBOLS } from 'libs/util-constants/src';
 
-import { getAddressFromBytes32, truncateAddress } from 'common-util/functions/addresses';
 import { useAppSelector } from 'store/index';
 
 import { ContractConfiguration } from './ContractConfiguration';
 import { useContractParams } from './hooks';
+import { getAddressFromBytes32, truncateAddress } from 'libs/util-functions/src';
 
 const StyledMain = styled.main`
   display: flex;

apps/govern/components/Contract/index.tsx

@@ -10,10 +10,7 @@ import { useAccount } from 'wagmi';
 import { CHAIN_NAMES, RETAINER_ADDRESS } from 'libs/util-constants/src';
 
 import { INVALIDATE_AFTER_UPDATE_KEYS } from 'common-util/constants/scopeKeys';
-import { getBytes32FromAddress } from 'common-util/functions/addresses';
 import { voteForNomineeWeights } from 'common-util/functions/requests';
-import { queryClient } from 'context/Web3ModalProvider';
-import { clearState } from 'store/govern';
 import { useAppDispatch, useAppSelector } from 'store/index';
 
 import { ConfirmModal } from './ConfirmModal';
@@ -24,6 +21,8 @@ import {
   checkNoRemovedNominees,
   checkNotNegativeSlope,
 } from './validations';
+import { resetState } from 'common-util/functions/resetState';
+import { getBytes32FromAddress } from 'libs/util-functions/src';
 
 const { Paragraph, Text } = Typography;
 
@@ -171,14 +170,8 @@ export const EditVotes = ({ allocations, setAllocations, setIsUpdating }: EditVo
         });
 
         setIsUpdating(false);
-        // Reset previously saved data so it's re-fetched automatically
-        queryClient.removeQueries({
-          predicate: (query) =>
-            INVALIDATE_AFTER_UPDATE_KEYS.includes(
-              (query.queryKey[1] as Record<string, string>)?.scopeKey,
-            ),
-        });
-        dispatch(clearState());
+
+        resetState(INVALIDATE_AFTER_UPDATE_KEYS, dispatch);
       })
       .catch((error) => {
         notification.error({

apps/govern/components/Contracts/EditVotes/index.tsx

@@ -30,14 +30,17 @@ const userVotes: Record<Address, UserVotes> = {
   '0x2': {
     current: { slope: 1, power: 8000, end: 1000 },
     next: { slope: 1, power: 8000, end: 1000 },
+    chainId: 1,
   },
   '0x3': {
     current: { slope: 1, power: 500, end: 500 },
     next: { slope: 1, power: 500, end: 500 },
+    chainId: 1,
   },
   '0x5': {
     current: { slope: 1, power: 1000, end: 1000 },
     next: { slope: 1, power: 1000, end: 1000 },
+    chainId: 1,
   },
 };