refactor: rename Comp.sol to ConfidentialERC20Votes.sol

README.md

@@ -75,7 +75,7 @@ These Solidity templates include governance-related and token-related contracts.
 
 ### Governance
 
-- [Comp](./contracts/governance/Comp.sol)
+- [ConfidentialERC20Votes](./contracts/governance/ConfidentialERC20Votes.sol)
 - [GovernorAlphaZama](./contracts/governance/GovernorAlphaZama.sol)
 
 ### Utils

contracts/governance/Comp.sol → contracts/governance/ConfidentialERC20Votes.sol

@@ -6,10 +6,10 @@ import { Ownable2Step, Ownable } from "@openzeppelin/contracts/access/Ownable2St
 import { EIP712 } from "@openzeppelin/contracts/utils/cryptography/EIP712.sol";
 import { SignatureChecker } from "@openzeppelin/contracts/utils/cryptography/SignatureChecker.sol";
 import { ConfidentialERC20 } from "../token/ERC20/ConfidentialERC20.sol";
-import { IComp } from "./IComp.sol";
+import { IConfidentialERC20Votes } from "./IConfidentialERC20Votes.sol";
 
 /**
- * @title       Comp
+ * @title       ConfidentialERC20Votes
  * @notice      This contract inherits ConfidentialERC20, EIP712, and Ownable2Step.
  *              This is based on the Comp.sol contract written by Compound Labs.
  *              see: compound-finance/compound-protocol/blob/master/contracts/Governance/Comp.sol
@@ -19,7 +19,7 @@ import { IComp } from "./IComp.sol";
  *              with an account's balance.
  * @dev         The delegation of votes leaks information about the account's encrypted balance to the `delegatee`.
  */
-abstract contract Comp is IComp, ConfidentialERC20, EIP712, Ownable2Step {
+abstract contract ConfidentialERC20Votes is IConfidentialERC20Votes, ConfidentialERC20, EIP712, Ownable2Step {
     /// @notice Returned if the `blockNumber` is higher or equal to the (current) `block.number`.
     /// @dev    It is returned in requests to access votes.
     error BlockNumberEqualOrHigherThanCurrentBlock();
@@ -161,7 +161,7 @@ abstract contract Comp is IComp, ConfidentialERC20, EIP712, Ownable2Step {
     }
 
     /**
-     * @notice See {IComp-getPriorVotesForGovernor}.
+     * @notice See {IConfidentialERC20Votes-getPriorVotesForGovernor}.
      */
     function getPriorVotesForGovernor(address account, uint256 blockNumber) public virtual returns (euint64 votes) {
         if (msg.sender != governor) {

contracts/governance/GovernorAlphaZama.sol

@@ -5,7 +5,7 @@ import "fhevm/lib/TFHE.sol";
 import "fhevm/gateway/GatewayCaller.sol";
 
 import { Ownable2Step, Ownable } from "@openzeppelin/contracts/access/Ownable2Step.sol";
-import { IComp } from "./IComp.sol";
+import { IConfidentialERC20Votes } from "./IConfidentialERC20Votes.sol";
 import { ICompoundTimelock } from "./ICompoundTimelock.sol";
 
 /**
@@ -197,12 +197,12 @@ abstract contract GovernorAlphaZama is Ownable2Step, GatewayCaller {
     uint256 public constant PROPOSAL_MAX_OPERATIONS = 10;
 
     /// @notice The number of votes required for a voter to become a proposer.
-    /// @dev    It is set at 100,000, which is 1% of the total supply of the Comp token.
+    /// @dev    It is set at 100,000, which is 1% of the total supply of the ConfidentialERC20Votes token.
     uint256 public constant PROPOSAL_THRESHOLD = 100000e6;
 
     /// @notice The number of votes in support of a proposal required in order for a quorum to be reached
     ///         and for a vote to succeed.
-    /// @dev    It is set at 400,000, which is 4% of the total supply of the Comp token.
+    /// @dev    It is set at 400,000, which is 4% of the total supply of the ConfidentialERC20Votes token.
     uint64 public constant QUORUM_VOTES = 400000e6;
 
     /// @notice The delay before voting on a proposal may take place once proposed.
@@ -214,8 +214,8 @@ abstract contract GovernorAlphaZama is Ownable2Step, GatewayCaller {
     ///         (i.e 21,600 for 12-second blocks).
     uint256 public immutable VOTING_PERIOD;
 
-    /// @notice Comp governance token.
-    IComp public immutable COMP;
+    /// @notice ConfidentialERC20Votes governance token.
+    IConfidentialERC20Votes public immutable CONFIDENTIAL_ERC20_VOTES;
 
     /// @notice Compound Timelock.
     ICompoundTimelock public immutable TIMELOCK;
@@ -253,15 +253,15 @@ abstract contract GovernorAlphaZama is Ownable2Step, GatewayCaller {
     /**
      * @param owner_            Owner address.
      * @param timelock_         Timelock contract.
-     * @param comp_             Comp token.
+     * @param comp_             ConfidentialERC20Votes token.
      * @param votingPeriod_     Voting period.
      * @dev                     Do not use a small value in production such as 5 or 20 to avoid security issues
      *                          unless for testing purpose. It should by at least a few days,.
      *                          For instance, 3 days would have a votingPeriod = 21,600 blocks if 12s per block.
      */
     constructor(address owner_, address timelock_, address comp_, uint256 votingPeriod_) Ownable(owner_) {
         TIMELOCK = ICompoundTimelock(timelock_);
-        COMP = IComp(comp_);
+        CONFIDENTIAL_ERC20_VOTES = IConfidentialERC20Votes(comp_);
         VOTING_PERIOD = votingPeriod_;
 
         /// @dev Store these constant-like variables in the storage.
@@ -443,7 +443,7 @@ abstract contract GovernorAlphaZama is Ownable2Step, GatewayCaller {
 
         ebool canPropose = TFHE.lt(
             _EUINT64_PROPOSAL_THRESHOLD,
-            COMP.getPriorVotesForGovernor(msg.sender, block.number - 1)
+            CONFIDENTIAL_ERC20_VOTES.getPriorVotesForGovernor(msg.sender, block.number - 1)
         );
 
         uint256[] memory cts = new uint256[](1);
@@ -645,7 +645,7 @@ abstract contract GovernorAlphaZama is Ownable2Step, GatewayCaller {
             revert VoterHasAlreadyVoted();
         }
 
-        euint64 votes = COMP.getPriorVotesForGovernor(voter, proposal.startBlock);
+        euint64 votes = CONFIDENTIAL_ERC20_VOTES.getPriorVotesForGovernor(voter, proposal.startBlock);
         proposal.forVotes = TFHE.select(support, TFHE.add(proposal.forVotes, votes), proposal.forVotes);
         proposal.againstVotes = TFHE.select(support, proposal.againstVotes, TFHE.add(proposal.againstVotes, votes));
 

contracts/governance/IComp.sol → contracts/governance/IConfidentialERC20Votes.sol

@@ -4,10 +4,10 @@ pragma solidity ^0.8.24;
 import "fhevm/lib/TFHE.sol";
 
 /**
- * @title       IComp
+ * @title       IConfidentialERC20Votes
  * @dev         The GovernorAlphaZama relies on this interface.
  */
-interface IComp {
+interface IConfidentialERC20Votes {
     /**
      * @notice              Determine the prior number of votes for an account as of a block number.
      * @dev                 Block number must be a finalized block or else this function will revert.

contracts/test/governance/TestComp.sol → contracts/test/governance/TestConfidentialERC20Votes.sol

@@ -1,17 +1,17 @@
 // SPDX-License-Identifier: BSD-3-Clause-Clear
 pragma solidity ^0.8.24;
 
-import { Comp } from "../../governance/Comp.sol";
+import { ConfidentialERC20Votes } from "../../governance/ConfidentialERC20Votes.sol";
 import { MockZamaFHEVMConfig } from "fhevm/config/ZamaFHEVMConfig.sol";
 
-contract TestComp is MockZamaFHEVMConfig, Comp {
+contract TestConfidentialERC20Votes is MockZamaFHEVMConfig, ConfidentialERC20Votes {
     constructor(
         address owner_,
         string memory name_,
         string memory symbol_,
         string memory version_,
         uint64 totalSupply_
-    ) Comp(owner_, name_, symbol_, version_, totalSupply_) {
+    ) ConfidentialERC20Votes(owner_, name_, symbol_, version_, totalSupply_) {
         //
     }
 }

docs/governance/Comp.md → docs/governance/ConfidentialERC20Votes.md

@@ -1,4 +1,4 @@
-# Comp
+# ConfidentialERC20Votes
 
 This contract inherits ConfidentialERC20, EIP712, and Ownable2Step. This is based on the Comp.sol contract written by
 Compound Labs. see: compound-finance/compound-protocol/blob/master/contracts/Governance/Comp.sol. It is a governance
@@ -151,7 +151,7 @@ The number of checkpoints for an `account`.
 ## \_checkpoints
 
 ```solidity
-mapping(address => mapping(uint32 => struct Comp.Checkpoint)) _checkpoints
+mapping(address => mapping(uint32 => struct ConfidentialERC20Votes.Checkpoint)) _checkpoints
 ```
 
 A record of votes \_checkpoints for an `account` using incremental indices.
@@ -223,7 +223,7 @@ _This function enables the sender to cancel a signature._
 function getPriorVotesForGovernor(address account, uint256 blockNumber) public virtual returns (euint64 votes)
 ```
 
-See {IComp-getPriorVotesForGovernor}.
+See {IConfidentialERC20Votes-getPriorVotesForGovernor}.
 
 ## getCurrentVotes
 

docs/governance/GovernorAlphaZama.md

@@ -301,7 +301,7 @@ uint256 PROPOSAL_THRESHOLD
 
 The number of votes required for a voter to become a proposer.
 
-_It is set at 100,000, which is 1% of the total supply of the Comp token._
+_It is set at 100,000, which is 1% of the total supply of the ConfidentialERC20Votes token._
 
 ## QUORUM_VOTES
 
@@ -311,7 +311,7 @@ uint64 QUORUM_VOTES
 
 The number of votes in support of a proposal required in order for a quorum to be reached and for a vote to succeed.
 
-_It is set at 400,000, which is 4% of the total supply of the Comp token._
+_It is set at 400,000, which is 4% of the total supply of the ConfidentialERC20Votes token._
 
 ## VOTING_DELAY
 
@@ -331,13 +331,13 @@ The duration of voting on a proposal, in blocks
 
 _It is recommended to be set at 3 days in blocks (i.e 21,600 for 12-second blocks)._
 
-## COMP
+## CONFIDENTIAL_ERC20_VOTES
 
 ```solidity
-contract IComp COMP
+contract IConfidentialERC20Votes CONFIDENTIAL_ERC20_VOTES
 ```
 
-Comp governance token.
+ConfidentialERC20Votes governance token.
 
 ## TIMELOCK
 
@@ -400,12 +400,12 @@ by at least a few days,. For instance, 3 days would have a votingPeriod = 21,600
 
 ### Parameters
 
-| Name           | Type    | Description        |
-| -------------- | ------- | ------------------ |
-| owner\_        | address | Owner address.     |
-| timelock\_     | address | Timelock contract. |
-| comp\_         | address | Comp token.        |
-| votingPeriod\_ | uint256 | Voting period.     |
+| Name                     | Type    | Description                   |
+| ------------------------ | ------- | ----------------------------- |
+| owner\_                  | address | Owner address.                |
+| timelock\_               | address | Timelock contract.            |
+| confidentialERC20Votes\_ | address | ConfidentialERC20Votes token. |
+| votingPeriod\_           | uint256 | Voting period.                |
 
 ## cancel
 

docs/governance/IComp.md → docs/governance/IConfidentialERC20Votes.md

@@ -1,4 +1,4 @@
-# IComp
+# IConfidentialERC20Votes
 
 _The GovernorAlphaZama relies on this interface._
 

test/governance/Comp.fixture.ts → test/governance/ConfidentialERC20Votes.fixture.ts

@@ -1,16 +1,16 @@
 import { parseUnits } from "ethers";
 import { ethers } from "hardhat";
 
-import type { TestComp } from "../../types";
+import type { TestConfidentialERC20Votes } from "../../types";
 import { reencryptEuint64 } from "../reencrypt";
 import { Signers } from "../signers";
 import { FhevmInstances } from "../types";
 
-export async function deployCompFixture(signers: Signers): Promise<TestComp> {
-  const contractFactory = await ethers.getContractFactory("TestComp");
+export async function deployConfidentialERC20Votes(signers: Signers): Promise<TestConfidentialERC20Votes> {
+  const contractFactory = await ethers.getContractFactory("TestConfidentialERC20Votes");
   const contract = await contractFactory
     .connect(signers.alice)
-    .deploy(signers.alice.address, "CompoundZama", "COMP", "1.0", parseUnits("10000000", 6));
+    .deploy(signers.alice.address, "CompoundZama", "CONFIDENTIAL_ERC20_VOTES", "1.0", parseUnits("10000000", 6));
   await contract.waitForDeployment();
   return contract;
 }
@@ -21,32 +21,34 @@ export async function transferTokensAndDelegate(
   transferAmount: bigint,
   account: string,
   delegate: string,
-  comp: TestComp,
+  confidentialERC20Votes: TestConfidentialERC20Votes,
   compAddress: string,
 ): Promise<void> {
   const input = instances.alice.createEncryptedInput(compAddress, signers.alice.address);
   input.add64(transferAmount);
   const encryptedTransferAmount = await input.encrypt();
 
-  let tx = await comp
+  let tx = await confidentialERC20Votes
     .connect(signers.alice)
     [
       "transfer(address,bytes32,bytes)"
     ](signers[account as keyof Signers], encryptedTransferAmount.handles[0], encryptedTransferAmount.inputProof);
   await tx.wait();
 
-  tx = await comp.connect(signers[account as keyof Signers]).delegate(signers[delegate as keyof Signers].address);
+  tx = await confidentialERC20Votes
+    .connect(signers[account as keyof Signers])
+    .delegate(signers[delegate as keyof Signers].address);
   await tx.wait();
 }
 
 export async function reencryptCurrentVotes(
   signers: Signers,
   instances: FhevmInstances,
   account: string,
-  comp: TestComp,
+  confidentialERC20Votes: TestConfidentialERC20Votes,
   compAddress: string,
 ): Promise<bigint> {
-  const voteHandle = await comp.getCurrentVotes(signers[account as keyof Signers].address);
+  const voteHandle = await confidentialERC20Votes.getCurrentVotes(signers[account as keyof Signers].address);
   const vote = await reencryptEuint64(signers, instances, account, voteHandle, compAddress);
   return vote;
 }
@@ -56,10 +58,10 @@ export async function reencryptPriorVotes(
   instances: FhevmInstances,
   account: string,
   blockNumber: number,
-  comp: TestComp,
+  confidentialERC20Votes: TestConfidentialERC20Votes,
   compAddress: string,
 ): Promise<bigint> {
-  const voteHandle = await comp.getPriorVotes(signers[account as keyof Signers].address, blockNumber);
+  const voteHandle = await confidentialERC20Votes.getPriorVotes(signers[account as keyof Signers].address, blockNumber);
   const vote = await reencryptEuint64(signers, instances, account, voteHandle, compAddress);
   return vote;
 }