Skip to content

Commit

Permalink
add Available since 4.1 comments
Browse files Browse the repository at this point in the history
(cherry picked from commit 9a698e6)
  • Loading branch information
Amxx committed Apr 19, 2021
1 parent 915109b commit df7996b
Show file tree
Hide file tree
Showing 13 changed files with 24 additions and 2 deletions.
2 changes: 2 additions & 0 deletions contracts/access/AccessControl.sol
Original file line number Diff line number Diff line change
Expand Up @@ -99,6 +99,8 @@ 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]{20}) is missing role (0x[0-9a-f]{32})$/
*
* _Available since v4.1._
*/
modifier onlyRole(bytes32 role) {
_checkRole(role, _msgSender());
Expand Down
2 changes: 2 additions & 0 deletions contracts/interfaces/IERC1271.sol
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@ pragma solidity ^0.8.0;
/**
* @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 {
/**
Expand Down
2 changes: 2 additions & 0 deletions contracts/interfaces/IERC3156.sol
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@ pragma solidity ^0.8.0;
/**
* @dev Interface of the ERC3156 FlashBorrower, as defined in
* https://eips.ethereum.org/EIPS/eip-3156[ERC-3156].
*
* _Available since v4.1._
*/
interface IERC3156FlashBorrower {
/**
Expand Down
2 changes: 2 additions & 0 deletions contracts/proxy/ERC1967/ERC1967Storage.sol
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,8 @@ import "../../utils/StorageSlot.sol";
/**
* @dev This abstract contract provides setters and getters for the different
* https://eips.ethereum.org/EIPS/eip-1967[EIP1967] storage slots.
*
* _Available since v4.1._
*/
abstract contract ERC1967Storage {
/**
Expand Down
2 changes: 2 additions & 0 deletions contracts/proxy/ERC1967/ERC1967Upgrade.sol
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,8 @@ import "./ERC1967Storage.sol";
* @dev This abstract contract provides event emitting update functions for
* https://eips.ethereum.org/EIPS/eip-1967[EIP1967] slots.
*
* _Available since v4.1._
*
* @custom:oz-upgrades-unsafe-allow delegatecall
*/
abstract contract ERC1967Upgrade is ERC1967Storage {
Expand Down
2 changes: 2 additions & 0 deletions contracts/proxy/utils/UUPSUpgradeable.sol
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,8 @@ import "../ERC1967/ERC1967Upgrade.sol";
* continuation of the upgradability.
*
* The {_authorizeUpgrade} function MUST be overridden to include access restriction to the upgrade mechanism.
*
* _Available since v4.1._
*/
abstract contract UUPSUpgradeable is ERC1967Upgrade {
function upgradeTo(address newImplementation) external virtual {
Expand Down
2 changes: 2 additions & 0 deletions contracts/token/ERC20/extensions/IERC20Metadata.sol
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@ import "../IERC20.sol";

/**
* @dev Interface for the optional metadata functions from the ERC20 standard.
*
* _Available since v4.1._
*/
interface IERC20Metadata is IERC20 {
/**
Expand Down
2 changes: 2 additions & 0 deletions contracts/token/ERC20/extensions/draft-ERC20FlashMint.sol
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,8 @@ import "../ERC20.sol";
*
* Adds the {flashLoan} method, which provides flash loan support at the token
* level. By default there is no fee, but this can be changed by overriding {flashFee}.
*
* _Available since v4.1._
*/
abstract contract ERC20FlashMint is ERC20, IERC3156FlashLender {
bytes32 constant private RETURN_VALUE = keccak256("ERC3156FlashBorrower.onFlashLoan");
Expand Down
2 changes: 2 additions & 0 deletions contracts/token/ERC20/extensions/draft-ERC20Permit.sol
Original file line number Diff line number Diff line change
Expand Up @@ -77,6 +77,8 @@ abstract contract ERC20Permit is ERC20, IERC20Permit, EIP712 {

/**
* @dev "Consume a nonce": return the current value and increment.
*
* _Available since v4.1._
*/
function _useNonce(address owner) internal virtual returns (uint256 current) {
Counters.Counter storage nonce = _nonces[owner];
Expand Down
2 changes: 2 additions & 0 deletions contracts/utils/Multicall.sol
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@ import "./Address.sol";

/**
* @dev Provides a function to batch together multiple calls in a single external call.
*
* _Available since v4.1._
*/
abstract contract Multicall {
/**
Expand Down
2 changes: 1 addition & 1 deletion contracts/utils/StorageSlot.sol
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ pragma solidity ^0.8.0;
* }
* ```
*
* Available since v4.1.0 for `address`, `bool`, `bytes32`, and `uint256`.
* _Available since v4.1 for `address`, `bool`, `bytes32`, and `uint256`._
*/
library StorageSlot {
struct AddressSlot {
Expand Down
2 changes: 1 addition & 1 deletion contracts/utils/cryptography/ECDSA.sol
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ library ECDSA {

// Check the signature length
// - case 65: r,s,v signature (standard)
// - case 64: r,vs signature (cf https://eips.ethereum.org/EIPS/eip-2098)
// - case 64: r,vs signature (cf https://eips.ethereum.org/EIPS/eip-2098) _Available since v4.1._
if (signature.length == 65) {
// ecrecover takes the signature parameters, and the only way to get them
// currently is to use assembly.
Expand Down
2 changes: 2 additions & 0 deletions contracts/utils/cryptography/SignatureChecker.sol
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,8 @@ import "../../interfaces/IERC1271.sol";
*
* Note: unlike ECDSA signatures, contract signature's are revocable, and the outcome of this function can thus change
* through time. It could return true at block N and false at block N+1 (or the opposite).
*
* _Available since v4.1._
*/
library SignatureChecker {
function isValidSignatureNow(address signer, bytes32 hash, bytes memory signature) internal view returns (bool) {
Expand Down

0 comments on commit df7996b

Please sign in to comment.