chore: updates NatSpec

zama-ai · Jan 6, 2025 · de71bf8 · de71bf8
1 parent 710f76f
commit de71bf8
Show file tree

Hide file tree

Showing 15 changed files with 170 additions and 127 deletions.
diff --git a/contracts/finance/ConfidentialVestingWallet.sol b/contracts/finance/ConfidentialVestingWallet.sol
@@ -2,11 +2,10 @@
 pragma solidity ^0.8.24;
 
 import "fhevm/lib/TFHE.sol";
-
 import { IConfidentialERC20 } from "../token/ERC20/IConfidentialERC20.sol";
 
 /**
- * @title  ConfidentialVestingWallet
+ * @title  ConfidentialVestingWallet.
  * @notice This contract offers a simple vesting wallet for ConfidentialERC20 tokens.
  *         This is based on the VestingWallet.sol contract written by OpenZeppelin.
  *         see: openzeppelin/openzeppelin-contracts/blob/master/contracts/finance/VestingWallet.sol
@@ -32,7 +31,6 @@ abstract contract ConfidentialVestingWallet {
 
     /// @notice Constant for zero using TFHE.
     /// @dev    Since it is expensive to compute 0, it is stored instead.
-    /* solhint-disable var-name-mixedcase*/
     euint64 internal immutable _EUINT64_ZERO;
 
     /// @notice Total encrypted amount released (to the beneficiary).

diff --git a/contracts/finance/ConfidentialVestingWalletCliff.sol b/contracts/finance/ConfidentialVestingWalletCliff.sol
@@ -2,11 +2,10 @@
 pragma solidity ^0.8.24;
 
 import "fhevm/lib/TFHE.sol";
-
 import { ConfidentialVestingWallet } from "./ConfidentialVestingWallet.sol";
 
 /**
- * @title  ConfidentialVestingWalletCliff
+ * @title  ConfidentialVestingWalletCliff.
  * @notice This contract offers a simple vesting wallet with a cliff for ConfidentialERC20 tokens.
  *         This is based on the VestingWalletCliff.sol contract written by OpenZeppelin.
  *         see: openzeppelin/openzeppelin-contracts/blob/master/contracts/finance/VestingWalletCliff.sol

diff --git a/contracts/governance/CompoundTimelock.sol b/contracts/governance/CompoundTimelock.sol
@@ -4,12 +4,11 @@ pragma solidity ^0.8.24;
 import { ICompoundTimelock } from "./ICompoundTimelock.sol";
 
 /**
- * @title       CompoundTimelock
- * @notice      This contract allows the admin to set a delay period before executing transactions.
- *              Transactions must be queued before execution. No transaction can be executed during this period,
- *              which offers time to verify the validity of pending transactions.
- *              It also has a grace period to allow for transactions
- *              not to be executed after a specific period following the queuing.
+ * @title   CompoundTimelock.
+ * @notice  This contract allows the admin to set a delay period before executing transactions.
+ *          Transactions must be queued before execution. No transaction can be executed during this period,
+ *          which offers time to verify the validity of pending transactions. It also has a grace period to allow
+ *          for transactions not to be executed after a specific period following the queuing.
  */
 contract CompoundTimelock is ICompoundTimelock {
     /**

diff --git a/contracts/governance/ConfidentialERC20Votes.sol b/contracts/governance/ConfidentialERC20Votes.sol
@@ -9,15 +9,14 @@ import { ConfidentialERC20 } from "../token/ERC20/ConfidentialERC20.sol";
 import { IConfidentialERC20Votes } from "./IConfidentialERC20Votes.sol";
 
 /**
- * @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
- *              It is a governance token used to delegate votes, which can be used by contracts such as
- *              ConfidentialGovernorAlpha.sol.
- *              It uses encrypted votes to delegate the voting power associated
- *              with an account's balance.
- * @dev         The delegation of votes leaks information about the account's encrypted balance to the `delegatee`.
+ * @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
+ *          It is a governance token used to delegate votes, which can be used by contracts such as
+ *          ConfidentialGovernorAlpha.
+ *          It uses encrypted votes to delegate the voting power associated with an account's balance.
+ * @dev     The delegation of votes leaks information about the account's encrypted balance to the `delegatee`.
  */
 abstract contract ConfidentialERC20Votes is IConfidentialERC20Votes, ConfidentialERC20, EIP712, Ownable2Step {
     /// @notice Returned if the `blockNumber` is higher or equal to the (current) `block.number`.

diff --git a/contracts/governance/ConfidentialGovernorAlpha.sol b/contracts/governance/ConfidentialGovernorAlpha.sol
@@ -3,21 +3,20 @@ pragma solidity ^0.8.24;
 
 import "fhevm/lib/TFHE.sol";
 import "fhevm/gateway/GatewayCaller.sol";
-
 import { Ownable2Step, Ownable } from "@openzeppelin/contracts/access/Ownable2Step.sol";
 import { IConfidentialERC20Votes } from "./IConfidentialERC20Votes.sol";
 import { ICompoundTimelock } from "./ICompoundTimelock.sol";
 
 /**
- * @title       ConfidentialGovernorAlpha
- * @notice      This is based on the GovernorAlpha.sol contract written by Compound Labs.
- *              see: compound-finance/compound-protocol/blob/master/contracts/Governance/GovernorAlpha.sol
- *              This decentralized governance system allows users to propose and vote on changes to the protocol.
- *              The contract is responsible for:
- *              - Proposal: A new proposal is made to introduce a change.
- *              - Voting: Users can vote on the proposal, either in favor or against it.
- *              - Quorum: A minimum number of votes (quorum) must be reached for the proposal to pass.
- *              - Execution: Once a proposal passes, it is executed and takes effect on the protocol.
+ * @title   ConfidentialGovernorAlpha.
+ * @notice  This is based on the GovernorAlpha.sol contract written by Compound Labs.
+ *          see: compound-finance/compound-protocol/blob/master/contracts/Governance/GovernorAlpha.sol
+ *          This decentralized governance system allows users to propose and vote on changes to the protocol.
+ *          The contract is responsible for:
+ *          - Proposal: A new proposal is made to introduce a change.
+ *          - Voting: Users can vote on the proposal, either in favor or against it.
+ *          - Quorum: A minimum number of votes (quorum) must be reached for the proposal to pass.
+ *          - Execution: Once a proposal passes, it is executed and takes effect on the protocol.
  */
 abstract contract ConfidentialGovernorAlpha is Ownable2Step, GatewayCaller {
     /// @notice Returned if proposal contains too many changes.

diff --git a/contracts/governance/ICompoundTimelock.sol b/contracts/governance/ICompoundTimelock.sol
@@ -2,7 +2,8 @@
 pragma solidity ^0.8.24;
 
 /**
- * @title       ICompoundTimelock
+ * @title ICompoundTimelock.
+ * @dev   The CompoundTimelock inherits this interface.
  */
 interface ICompoundTimelock {
     /// @notice Returned if the delay is below the minimum delay.

diff --git a/contracts/governance/IConfidentialERC20Votes.sol b/contracts/governance/IConfidentialERC20Votes.sol
@@ -4,8 +4,8 @@ pragma solidity ^0.8.24;
 import "fhevm/lib/TFHE.sol";
 
 /**
- * @title       IConfidentialERC20Votes
- * @dev         The ConfidentialGovernorAlpha relies on this interface.
+ * @title   IConfidentialERC20Votes.
+ * @dev     Governor contracts use this interface to build a logic using votes.
  */
 interface IConfidentialERC20Votes {
     /**

diff --git a/contracts/token/ERC20/ConfidentialERC20.sol b/contracts/token/ERC20/ConfidentialERC20.sol
@@ -2,18 +2,17 @@
 pragma solidity ^0.8.24;
 
 import "fhevm/lib/TFHE.sol";
-
 import { IERC20Errors } from "@openzeppelin/contracts/interfaces/draft-IERC6093.sol";
 import { IConfidentialERC20 } from "./IConfidentialERC20.sol";
 import { TFHEErrors } from "../../utils/TFHEErrors.sol";
 
 /**
- * @title       ConfidentialERC20
- * @notice      This contract implements an encrypted ERC20-like token with confidential balances using
- *              Zama's FHE (Fully Homomorphic Encryption) library.
- * @dev         It supports standard ERC20 functions such as transferring tokens, minting,
- *              and setting allowances, but uses encrypted data types.
- *              The total supply is not encrypted.
+ * @title   ConfidentialERC20.
+ * @notice  This contract implements an encrypted ERC20-like token with confidential balances using
+ *          Zama's FHE (Fully Homomorphic Encryption) library.
+ * @dev     It supports standard ERC20 functions such as transferring tokens, minting,
+ *          and setting allowances, but uses encrypted data types.
+ *          The total supply is not encrypted.
  */
 abstract contract ConfidentialERC20 is IConfidentialERC20, IERC20Errors, TFHEErrors {
     /// @notice Used as a placeholder in `Approval` & `Transfer` events to comply with the official EIP20.

diff --git a/contracts/token/ERC20/ConfidentialERC20Wrapped.sol b/contracts/token/ERC20/ConfidentialERC20Wrapped.sol
@@ -1,23 +1,19 @@
 // SPDX-License-Identifier: BSD-3-Clause-Clear
 pragma solidity ^0.8.24;
 
+import "fhevm/lib/TFHE.sol";
+import "fhevm/gateway/GatewayCaller.sol";
 import { IERC20Metadata } from "@openzeppelin/contracts/token/ERC20/extensions/IERC20Metadata.sol";
 import { SafeERC20 } from "@openzeppelin/contracts/token/ERC20/utils/SafeERC20.sol";
 import { ReentrancyGuardTransient } from "@openzeppelin/contracts/utils/ReentrancyGuardTransient.sol";
-
-import "fhevm/lib/TFHE.sol";
-import "fhevm/gateway/GatewayCaller.sol";
-
 import { IConfidentialERC20Wrapped } from "./IConfidentialERC20Wrapped.sol";
 import { ConfidentialERC20 } from "./ConfidentialERC20.sol";
 
 /**
- * @title             ConfidentialERC20Wrapped
- * @notice            This contract allows users to wrap/unwrap trustlessly
- *                    ERC20 tokens to ConfidentialERC20 tokens.
- * @dev               This implementation does not support tokens with rebase functions or
- *                    tokens with a fee on transfer. All ERC20 tokens must have decimals
- *                    inferior or equal to 18 decimals but superior or equal to 6 decimals.
+ * @title   ConfidentialERC20Wrapped.
+ * @notice  This contract allows users to wrap/unwrap trustlessly ERC20 tokens to ConfidentialERC20 tokens.
+ * @dev     This implementation does not support tokens with rebase functions or tokens with a fee on transfer.
+ *          All ERC20 tokens must have decimals superior or equal to 6 decimals.
  */
 abstract contract ConfidentialERC20Wrapped is
     ConfidentialERC20,
@@ -40,7 +36,6 @@ abstract contract ConfidentialERC20Wrapped is
     mapping(uint256 requestId => UnwrapRequest unwrapRequest) public unwrapRequests;
 
     /**
-     * @notice                          Deposit/withdraw ERC20 tokens using confidential ERC20 tokens.
      * @param erc20_                    Address of the ERC20 token to wrap/unwrap.
      * @dev                             The name/symbol are autogenerated.
      *                                  For instance,

diff --git a/contracts/token/ERC20/ConfidentialWETH.sol b/contracts/token/ERC20/ConfidentialWETH.sol
@@ -1,18 +1,16 @@
 // SPDX-License-Identifier: BSD-3-Clause-Clear
 pragma solidity ^0.8.24;
 
-import { ConfidentialERC20 } from "./ConfidentialERC20.sol";
-import { ReentrancyGuardTransient } from "@openzeppelin/contracts/utils/ReentrancyGuardTransient.sol";
-
 import "fhevm/lib/TFHE.sol";
 import "fhevm/gateway/GatewayCaller.sol";
-
+import { ReentrancyGuardTransient } from "@openzeppelin/contracts/utils/ReentrancyGuardTransient.sol";
+import { ConfidentialERC20 } from "./ConfidentialERC20.sol";
 import { IConfidentialERC20Wrapped } from "./IConfidentialERC20Wrapped.sol";
 
 /**
- * @title             ConfidentialWETH
- * @notice            This contract allows users to wrap/unwrap trustlessly
- *                    ETH (or other native tokens) to ConfidentialERC20 tokens.
+ * @title   ConfidentialWETH.
+ * @notice  This contract allows users to wrap/unwrap trustlessly
+ *          ETH (or other native tokens) to ConfidentialERC20 tokens.
  */
 abstract contract ConfidentialWETH is
     ConfidentialERC20,
@@ -33,7 +31,7 @@ abstract contract ConfidentialWETH is
     mapping(uint256 requestId => UnwrapRequest unwrapRequest) public unwrapRequests;
 
     /**
-     * @notice                          Deposit/withdraw ethers (or native tokens).
+     * @notice                          Deposit/withdraw ethers (or other native tokens).
      * @dev                             The name/symbol are autogenerated.
      * @param maxDecryptionDelay_       Maximum delay for the Gateway to decrypt.
      * @dev                             Do not use a small value in production to avoid security issues if the response
@@ -51,14 +49,14 @@ abstract contract ConfidentialWETH is
     }
 
     /**
-     * @notice         Receive function calls wrap().
+     * @notice  Receive function calls wrap().
      */
     receive() external payable {
         wrap();
     }
 
     /**
-     * @notice         Unwrap ConfidentialERC20 tokens to ether.
+     * @notice         Unwrap ConfidentialERC20 tokens to ether (or other native tokens).
      * @param amount   Amount to unwrap.
      */
     function unwrap(uint64 amount) public virtual {
@@ -83,7 +81,7 @@ abstract contract ConfidentialWETH is
     }
 
     /**
-     * @notice         Wrap ether to an encrypted format.
+     * @notice Wrap ether (or other native token) to an encrypted format.
      */
     function wrap() public payable virtual {
         uint256 amountAdjusted = (msg.value) / (10 ** (18 - decimals()));