OpenZeppelin · Amxx · Jul 6, 2023 · Jul 5, 2023 · Jul 5, 2023 · Jul 5, 2023
@@ -64,8 +64,6 @@ abstract contract AccessControl is Context, IAccessControl, ERC165 {
      * The format of the revert reason is given by the following regular expression:
      *
      *  /^AccessControl: account (0x[0-9a-f]{40}) is missing role (0x[0-9a-f]{64})$/
-     *
-     * _Available since v4.1._
      */
     modifier onlyRole(bytes32 role) {
         _checkRole(role);
@@ -91,8 +89,6 @@ abstract contract AccessControl is Context, IAccessControl, ERC165 {
      * Overriding this function changes the behavior of the {onlyRole} modifier.
      *
      * Format of the revert message is described in {_checkRole}.
-     *
-     * _Available since v4.6._
      */
     function _checkRole(bytes32 role) internal view virtual {
         _checkRole(role, _msgSender());

@@ -35,8 +35,6 @@ import {IERC5313} from "../interfaces/IERC5313.sol";
  *    ) {}
  * }
  * ```
- *
- * _Available since v4.9._
  */
 abstract contract AccessControlDefaultAdminRules is IAccessControlDefaultAdminRules, IERC5313, AccessControl {
     // pending admin pair read/written together frequently

@@ -24,8 +24,6 @@ interface IAccessControl {
      *
      * `DEFAULT_ADMIN_ROLE` is the starting admin for all roles, despite
      * {RoleAdminChanged} not being emitted signaling this.
-     *
-     * _Available since v3.1._
      */
     event RoleAdminChanged(bytes32 indexed role, bytes32 indexed previousAdminRole, bytes32 indexed newAdminRole);
 

@@ -7,8 +7,6 @@ import {IAccessControl} from "./IAccessControl.sol";
 
 /**
  * @dev External interface of AccessControlDefaultAdminRules declared to support ERC165 detection.
- *
- * _Available since v4.9._
  */
 interface IAccessControlDefaultAdminRules is IAccessControl {
     /**

@@ -23,8 +23,6 @@ import {IGovernor, IERC6372} from "./IGovernor.sol";
  * - A counting module must implement {quorum}, {_quorumReached}, {_voteSucceeded} and {_countVote}
  * - A voting module must implement {_getVotes}
  * - Additionally, {votingPeriod} must also be implemented
- *
- * _Available since v4.3._
  */
 abstract contract Governor is Context, ERC165, EIP712, Nonces, IGovernor, IERC721Receiver, IERC1155Receiver {
     using DoubleEndedQueue for DoubleEndedQueue.Bytes32Deque;

@@ -8,8 +8,6 @@ import {IERC6372} from "../interfaces/IERC6372.sol";
 
 /**
  * @dev Interface of the {Governor} core.
- *
- * _Available since v4.3._
  */
 abstract contract IGovernor is IERC165, IERC6372 {
     enum ProposalState {

@@ -21,8 +21,6 @@ import {Address} from "../utils/Address.sol";
  * is in charge of proposing (resp executing) operations. A common use case is
  * to position this {TimelockController} as the owner of a smart contract, with
  * a multisig or a DAO as the sole proposer.
- *
- * _Available since v3.3._
  */
 contract TimelockController is AccessControl, ERC721Holder, ERC1155Holder {
     bytes32 public constant PROPOSER_ROLE = keccak256("PROPOSER_ROLE");

@@ -15,8 +15,6 @@ import {IGovernorCompatibilityBravo} from "./IGovernorCompatibilityBravo.sol";
  * through inheritance. It does not include token bindings, nor does it include any variable upgrade patterns.
  *
  * NOTE: When using this module, you may need to enable the Solidity optimizer to avoid hitting the contract size limit.
- *
- * _Available since v4.3._
  */
 abstract contract GovernorCompatibilityBravo is IGovernorTimelock, IGovernorCompatibilityBravo, Governor {
     enum VoteType {

@@ -7,8 +7,6 @@ import {IGovernor} from "../IGovernor.sol";
 
 /**
  * @dev Interface extension that adds missing functions to the {Governor} core to provide `GovernorBravo` compatibility.
- *
- * _Available since v4.3._
  */
 abstract contract IGovernorCompatibilityBravo is IGovernor {
     /**

@@ -7,8 +7,6 @@ import {Governor} from "../Governor.sol";
 
 /**
  * @dev Extension of {Governor} for simple, 3 options, vote counting.
- *
- * _Available since v4.3._
  */
 abstract contract GovernorCountingSimple is Governor {
     /**

@@ -14,8 +14,6 @@ import {Math} from "../../utils/math/Math.sol";
  * If a vote causes quorum to be reached, the proposal's voting period may be extended so that it does not end before at
  * least a specified time has passed (the "vote extension" parameter). This parameter can be set through a governance
  * proposal.
- *
- * _Available since v4.5._
  */
 abstract contract GovernorPreventLateQuorum is Governor {
     uint48 private _voteExtension;

@@ -7,8 +7,6 @@ import {Governor} from "../Governor.sol";
 
 /**
  * @dev Extension of {Governor} for settings updatable through governance.
- *
- * _Available since v4.4._
  */
 abstract contract GovernorSettings is Governor {
     // amount of token

@@ -19,8 +19,6 @@ import {Address} from "../../utils/Address.sol";
  * Using this model means the proposal will be operated by the {TimelockController} and not by the {Governor}. Thus,
  * the assets and permissions must be attached to the {TimelockController}. Any asset sent to the {Governor} will be
  * inaccessible.
- *
- * _Available since v4.3._
  */
 abstract contract GovernorTimelockCompound is IGovernorTimelock, Governor {
     ICompoundTimelock private _timelock;

@@ -21,8 +21,6 @@ import {IERC165} from "../../interfaces/IERC165.sol";
  * grants them powers that they must be trusted or known not to use: 1) {onlyGovernance} functions like {relay} are
  * available to them through the timelock, and 2) approved governance proposals can be blocked by them, effectively
  * executing a Denial of Service attack. This risk will be mitigated in a future release.
- *
- * _Available since v4.3._
  */
 abstract contract GovernorTimelockControl is IGovernorTimelock, Governor {
     TimelockController private _timelock;

@@ -10,8 +10,6 @@ import {SafeCast} from "../../utils/math/SafeCast.sol";
 
 /**
  * @dev Extension of {Governor} for voting weight extraction from an {ERC20Votes} token, or since v4.5 an {ERC721Votes} token.
- *
- * _Available since v4.3._
  */
 abstract contract GovernorVotes is Governor {
     IERC5805 public immutable token;

@@ -10,8 +10,6 @@ import {Checkpoints} from "../../utils/structs/Checkpoints.sol";
 /**
  * @dev Extension of {Governor} for voting weight extraction from an {ERC20Votes} token and a quorum expressed as a
  * fraction of the total supply.
- *
- * _Available since v4.3._
  */
 abstract contract GovernorVotesQuorumFraction is GovernorVotes {
     using Checkpoints for Checkpoints.Trace224;

@@ -7,8 +7,6 @@ import {IGovernor} from "../IGovernor.sol";
 
 /**
  * @dev Extension of the {IGovernor} for timelock supporting modules.
- *
- * _Available since v4.3._
  */
 abstract contract IGovernorTimelock is IGovernor {
     /**

@@ -4,8 +4,6 @@ pragma solidity ^0.8.19;
 
 /**
  * @dev Common interface for {ERC20Votes}, {ERC721Votes}, and other {Votes}-enabled contracts.
- *
- * _Available since v4.5._
  */
 interface IVotes {
     /**

@@ -27,8 +27,6 @@ import {ECDSA} from "../../utils/cryptography/ECDSA.sol";
  * When using this module the derived contract must implement {_getVotingUnits} (for example, make it return
  * {ERC721-balanceOf}), and can use {_transferVotingUnits} to track a change in the distribution of those units (in the
  * previous example, it would be included in {ERC721-_beforeTokenTransfer}).
- *
- * _Available since v4.5._
  */
 abstract contract Votes is Context, EIP712, Nonces, IERC5805 {
     using Checkpoints for Checkpoints.Trace224;

@@ -6,8 +6,6 @@ pragma solidity ^0.8.19;
 /**
  * @dev Interface of the ERC1271 standard signature validation method for
  * contracts as defined in https://eips.ethereum.org/EIPS/eip-1271[ERC-1271].
- *
- * _Available since v4.1._
  */
 interface IERC1271 {
     /**

@@ -5,8 +5,6 @@ pragma solidity ^0.8.19;
 
 /**
  * @dev ERC-1967: Proxy Storage Slots. This interface contains the events defined in the ERC.
- *
- * _Available since v4.8.3._
  */
 interface IERC1967 {
     /**

@@ -5,8 +5,6 @@ pragma solidity ^0.8.19;
 
 /**
  * @dev ERC-2309: ERC-721 Consecutive Transfer Extension.
- *
- * _Available since v4.8._
  */
 interface IERC2309 {
     /**

@@ -10,8 +10,6 @@ import {IERC165} from "../utils/introspection/IERC165.sol";
  *
  * A standardized way to retrieve royalty payment information for non-fungible tokens (NFTs) to enable universal
  * support for royalty payments across all NFT marketplaces and ecosystem participants.
- *
- * _Available since v4.5._
  */
 interface IERC2981 is IERC165 {
     /**

@@ -6,8 +6,6 @@ pragma solidity ^0.8.19;
 /**
  * @dev Interface of the ERC3156 FlashBorrower, as defined in
  * https://eips.ethereum.org/EIPS/eip-3156[ERC-3156].
- *
- * _Available since v4.1._
  */
 interface IERC3156FlashBorrower {
     /**

@@ -8,8 +8,6 @@ import {IERC3156FlashBorrower} from "./IERC3156FlashBorrower.sol";
 /**
  * @dev Interface of the ERC3156 FlashLender, as defined in
  * https://eips.ethereum.org/EIPS/eip-3156[ERC-3156].
- *
- * _Available since v4.1._
  */
 interface IERC3156FlashLender {
     /**

@@ -9,8 +9,6 @@ import {IERC20Metadata} from "../token/ERC20/extensions/IERC20Metadata.sol";
 /**
  * @dev Interface of the ERC4626 "Tokenized Vault Standard", as defined in
  * https://eips.ethereum.org/EIPS/eip-4626[ERC-4626].
- *
- * _Available since v4.7._
  */
 interface IERC4626 is IERC20, IERC20Metadata {
     event Deposit(address indexed sender, address indexed owner, uint256 assets, uint256 shares);

@@ -7,8 +7,6 @@ pragma solidity ^0.8.19;
  * @dev Interface for the Light Contract Ownership Standard.
  *
  * A standardized minimal interface required to identify an account that controls a contract
- *
- * _Available since v4.9._
  */
 interface IERC5313 {
     /**

@@ -13,8 +13,6 @@ pragma solidity ^0.8.19;
  * The library includes functions to deploy a proxy using either `create` (traditional deployment) or `create2`
  * (salted deterministic deployment). It also includes functions to predict the addresses of clones deployed using the
  * deterministic method.
- *
- * _Available since v3.4._
  */
 library Clones {
     /**

@@ -10,8 +10,6 @@ import {StorageSlot} from "../../utils/StorageSlot.sol";
 /**
  * @dev This abstract contract provides getters and event emitting update functions for
  * https://eips.ethereum.org/EIPS/eip-1967[EIP1967] slots.
- *
- * _Available since v4.1._
  */
 library ERC1967Utils {
     // We re-declare ERC-1967 events here because they can't be used directly from IERC1967.

@@ -12,8 +12,6 @@ import {ERC1967Utils} from "../ERC1967/ERC1967Utils.sol";
  *
  * The beacon address is stored in storage slot `uint256(keccak256('eip1967.proxy.beacon')) - 1`, so that it doesn't
  * conflict with the storage layout of the implementation behind the proxy.
- *
- * _Available since v3.4._
  */
 contract BeaconProxy is Proxy {
     /**

@@ -15,8 +15,6 @@ import {ERC1967Utils} from "../ERC1967/ERC1967Utils.sol";
  * `UUPSUpgradeable` with a custom implementation of upgrades.
  *
  * The {_authorizeUpgrade} function must be overridden to include access restriction to the upgrade mechanism.
- *
- * _Available since v4.1._
  */
 abstract contract UUPSUpgradeable is IERC1822Proxiable {
     /// @custom:oz-upgrades-unsafe-allow state-variable-immutable state-variable-assignment

@@ -15,8 +15,6 @@ import {IERC1155Errors} from "../../interfaces/draft-IERC6093.sol";
  * @dev Implementation of the basic standard multi-token.
  * See https://eips.ethereum.org/EIPS/eip-1155
  * Originally based on code by Enjin: https://github.com/enjin/erc-1155
- *
- * _Available since v3.1._
  */
 abstract contract ERC1155 is Context, ERC165, IERC1155, IERC1155MetadataURI, IERC1155Errors {
     using Arrays for uint256[];

@@ -8,8 +8,6 @@ import {IERC165} from "../../utils/introspection/IERC165.sol";
 /**
  * @dev Required interface of an ERC1155 compliant contract, as defined in the
  * https://eips.ethereum.org/EIPS/eip-1155[EIP].
- *
- * _Available since v3.1._
  */
 interface IERC1155 is IERC165 {
     /**

@@ -6,7 +6,8 @@ pragma solidity ^0.8.19;
 import {IERC165} from "../../utils/introspection/IERC165.sol";
 
 /**
- * @dev _Available since v3.1._
+ * @dev Interface that must be implemented by smart contracts in order to receive
+ * ERC-1155 token transfers.
  */
 interface IERC1155Receiver is IERC165 {
     /**

@@ -8,8 +8,6 @@ import {ERC1155} from "../ERC1155.sol";
 /**
  * @dev Extension of {ERC1155} that allows token holders to destroy both their
  * own tokens and those that they have been approved to use.
- *
- * _Available since v3.1._
  */
 abstract contract ERC1155Burnable is ERC1155 {
     function burn(address account, uint256 id, uint256 value) public virtual {

@@ -18,8 +18,6 @@ import {Pausable} from "../../../security/Pausable.sol";
  * {Pausable-_pause} and {Pausable-_unpause} internal functions, with appropriate
  * access control, e.g. using {AccessControl} or {Ownable}. Not doing so will
  * make the contract pause mechanism of the contract unreachable, and thus unusable.
- *
- * _Available since v3.1._
  */
 abstract contract ERC1155Pausable is ERC1155, Pausable {
     /**

@@ -9,8 +9,6 @@ import {ERC1155} from "../ERC1155.sol";
 /**
  * @dev ERC1155 token with storage based token URI management.
  * Inspired by the ERC721URIStorage extension
- *
- * _Available since v4.6._
  */
 abstract contract ERC1155URIStorage is ERC1155 {
     using Strings for uint256;

@@ -8,8 +8,6 @@ import {IERC1155} from "../IERC1155.sol";
 /**
  * @dev Interface of the optional ERC1155MetadataExtension interface, as defined
  * in the https://eips.ethereum.org/EIPS/eip-1155#metadata-extensions[EIP].
- *
- * _Available since v3.1._
  */
 interface IERC1155MetadataURI is IERC1155 {
     /**

@@ -6,12 +6,10 @@ pragma solidity ^0.8.19;
 import {ERC1155Receiver} from "./ERC1155Receiver.sol";
 
 /**
- * Simple implementation of `ERC1155Receiver` that will allow a contract to hold ERC1155 tokens.
+ * @dev Simple implementation of `ERC1155Receiver` that will allow a contract to hold ERC1155 tokens.
  *
  * IMPORTANT: When inheriting this contract, you must include a way to use the received tokens, otherwise they will be
  * stuck.
- *
- * @dev _Available since v3.1._
  */
 abstract contract ERC1155Holder is ERC1155Receiver {
     function onERC1155Received(

@@ -7,7 +7,9 @@ import {IERC1155Receiver} from "../IERC1155Receiver.sol";
 import {IERC165, ERC165} from "../../../utils/introspection/ERC165.sol";
 
 /**
- * @dev _Available since v3.1._
+ * @dev Basic contract implementing the ERC-165 interface for {IERC1155Receiver}.
+ *
+ * NOTE: This contract does not suffice to receive tokens. See {ERC1155Holder}.
  */
 abstract contract ERC1155Receiver is ERC165, IERC1155Receiver {
     /**

@@ -17,8 +17,6 @@ import {ERC20} from "../ERC20.sol";
  * NOTE: When this extension is used along with the {ERC20Capped} or {ERC20Votes} extensions,
  * {maxFlashLoan} will not correctly reflect the maximum that can be flash minted. We recommend
  * overriding {maxFlashLoan} so that it correctly reflects the supply cap.
- *
- * _Available since v4.1._
  */
 abstract contract ERC20FlashMint is ERC20, IERC3156FlashLender {
     bytes32 private constant _RETURN_VALUE = keccak256("ERC3156FlashBorrower.onFlashLoan");

@@ -16,8 +16,6 @@ import {Nonces} from "../../../utils/Nonces.sol";
  * Adds the {permit} method, which can be used to change an account's ERC20 allowance (see {IERC20-allowance}) by
  * presenting a message signed by the account. By not relying on `{IERC20-approve}`, the token holder account doesn't
  * need to send a transaction, and thus is not required to hold Ether at all.
- *
- * _Available since v3.4._
  */
 abstract contract ERC20Permit is ERC20, IERC20Permit, EIP712, Nonces {
     // solhint-disable-next-line var-name-mixedcase
-Original file line number
+Diff line change
@@ Expand Up / @@ -35,8 +35,6 @@ import {IERC5313} from "../interfaces/IERC5313.sol"; @@
      *    ) {}
      * }
      * ```
-     *
-     * _Available since v4.9._
      */
     abstract contract AccessControlDefaultAdminRules is IAccessControlDefaultAdminRules, IERC5313, AccessControl {
         // pending admin pair read/written together frequently
@@ Expand Down @@