Add ERC7984Freezable

.changeset/seven-books-dig.md

@@ -2,4 +2,4 @@
 'openzeppelin-confidential-contracts': minor
 ---
 
-`ERC7984Freezable`: Add an extension to `ERC7984`, which allows accounts granted the "freezer" role to freeze and unfreeze tokens.
+`ERC7984Freezable`: Add an extension to `ERC7984`, which allows an account granted the "freezer" role to freeze and unfreeze a confidential amount of tokens for holders.

contracts/token/ERC7984/extensions/ERC7984Freezable.sol

@@ -7,16 +7,16 @@ import {FHESafeMath} from "../../../utils/FHESafeMath.sol";
 import {ERC7984} from "../ERC7984.sol";
 
 /**
- * Inspired by https://github.com/OpenZeppelin/openzeppelin-community-contracts/blob/master/contracts/token/ERC20/extensions/ERC20Freezable.sol
- *
  * @dev Extension of {ERC7984} that allows to implement a confidential
  * freezing mechanism that can be managed by an authorized account with
- * the {_setConfidentialFrozen} function.
+ * {setConfidentialFrozen} functions.
  *
  * The freezing mechanism provides the guarantee to the contract owner
  * (e.g. a DAO or a well-configured multisig) that a specific confidential
  * amount of tokens held by an account won't be transferable until those
  * tokens are unfrozen.
+ *
+ * Inspired by https://github.com/OpenZeppelin/openzeppelin-community-contracts/blob/master/contracts/token/ERC20/extensions/ERC20Freezable.sol
  */
 abstract contract ERC7984Freezable is ERC7984 {
     /// @dev Confidential frozen amount of tokens per address.

contracts/token/README.adoc

@@ -7,13 +7,15 @@ This set of interfaces, contracts, and utilities are all related to `ERC7984`, a
 
 - {ERC7984}: Implementation of {IERC7984}.
 - {ERC7984ERC20Wrapper}: Extension of {ERC7984} which wraps an `ERC20` into a confidential token. The wrapper allows for free conversion in both directions at a fixed rate.
+- {ERC7984Freezable}: An extension for {ERC7984}, which allows an account granted the "freezer" role to freeze and unfreeze a confidential amount of tokens for holders.
 - {ERC7984Utils}: A library that provides the on-transfer callback check used by {ERC7984}. 
 
 == Core
 {{ERC7984}}
 
 == Extensions
 {{ERC7984ERC20Wrapper}}
+{{ERC7984Freezable}}
 
 == Utilities
 {{ERC7984Utils}}