From a0e2bca79a45cbcd889b87ba9da2016c2e0d2948 Mon Sep 17 00:00:00 2001 From: Francisco Giordano Date: Mon, 1 Feb 2021 21:44:58 -0300 Subject: [PATCH] Add "available since" comments in documentation (cherry picked from commit 63a0343dda0b553319a799c63e4fa23f2f3737da) --- contracts/drafts/EIP712.sol | 2 ++ contracts/drafts/ERC20Permit.sol | 2 ++ contracts/introspection/ERC165Checker.sol | 2 ++ contracts/math/SafeMath.sol | 10 ++++++++++ contracts/presets/ERC20PresetFixedSupply.sol | 2 ++ contracts/presets/ERC777PresetFixedSupply.sol | 2 ++ contracts/proxy/BeaconProxy.sol | 2 ++ contracts/proxy/Clones.sol | 2 ++ contracts/utils/Address.sol | 4 ++-- contracts/utils/EnumerableMap.sol | 2 ++ 10 files changed, 28 insertions(+), 2 deletions(-) diff --git a/contracts/drafts/EIP712.sol b/contracts/drafts/EIP712.sol index 65c131c7e..2f90e24e1 100644 --- a/contracts/drafts/EIP712.sol +++ b/contracts/drafts/EIP712.sol @@ -18,6 +18,8 @@ pragma solidity >=0.6.0 <0.8.0; * * NOTE: This contract implements the version of the encoding known as "v4", as implemented by the JSON RPC method * https://docs.metamask.io/guide/signing-data.html[`eth_signTypedDataV4` in MetaMask]. + * + * _Available since v3.4._ */ abstract contract EIP712 { /* solhint-disable var-name-mixedcase */ diff --git a/contracts/drafts/ERC20Permit.sol b/contracts/drafts/ERC20Permit.sol index b7c094b82..4cc972d1a 100644 --- a/contracts/drafts/ERC20Permit.sol +++ b/contracts/drafts/ERC20Permit.sol @@ -15,6 +15,8 @@ import "./EIP712.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 { using Counters for Counters.Counter; diff --git a/contracts/introspection/ERC165Checker.sol b/contracts/introspection/ERC165Checker.sol index b538489ad..7250a7687 100644 --- a/contracts/introspection/ERC165Checker.sol +++ b/contracts/introspection/ERC165Checker.sol @@ -47,6 +47,8 @@ library ERC165Checker { * is that some interfaces may not be supported. * * See {IERC165-supportsInterface}. + * + * _Available since v3.4._ */ function getSupportedInterfaces(address account, bytes4[] memory interfaceIds) internal view returns (bool[] memory) { // an array of booleans corresponding to interfaceIds and whether they're supported or not diff --git a/contracts/math/SafeMath.sol b/contracts/math/SafeMath.sol index 413251e58..3e81f295b 100644 --- a/contracts/math/SafeMath.sol +++ b/contracts/math/SafeMath.sol @@ -18,6 +18,8 @@ pragma solidity >=0.6.0 <0.8.0; library SafeMath { /** * @dev Returns the addition of two unsigned integers, with an overflow flag. + * + * _Available since v3.4._ */ function tryAdd(uint256 a, uint256 b) internal pure returns (bool, uint256) { uint256 c = a + b; @@ -27,6 +29,8 @@ library SafeMath { /** * @dev Returns the substraction of two unsigned integers, with an overflow flag. + * + * _Available since v3.4._ */ function trySub(uint256 a, uint256 b) internal pure returns (bool, uint256) { if (b > a) return (false, 0); @@ -35,6 +39,8 @@ library SafeMath { /** * @dev Returns the multiplication of two unsigned integers, with an overflow flag. + * + * _Available since v3.4._ */ function tryMul(uint256 a, uint256 b) internal pure returns (bool, uint256) { // Gas optimization: this is cheaper than requiring 'a' not being zero, but the @@ -48,6 +54,8 @@ library SafeMath { /** * @dev Returns the division of two unsigned integers, with a division by zero flag. + * + * _Available since v3.4._ */ function tryDiv(uint256 a, uint256 b) internal pure returns (bool, uint256) { if (b == 0) return (false, 0); @@ -56,6 +64,8 @@ library SafeMath { /** * @dev Returns the remainder of dividing two unsigned integers, with a division by zero flag. + * + * _Available since v3.4._ */ function tryMod(uint256 a, uint256 b) internal pure returns (bool, uint256) { if (b == 0) return (false, 0); diff --git a/contracts/presets/ERC20PresetFixedSupply.sol b/contracts/presets/ERC20PresetFixedSupply.sol index 839110952..085d3d217 100644 --- a/contracts/presets/ERC20PresetFixedSupply.sol +++ b/contracts/presets/ERC20PresetFixedSupply.sol @@ -12,6 +12,8 @@ import "../token/ERC20/ERC20Burnable.sol"; * * This contract uses {ERC20Burnable} to include burn capabilities - head to * its documentation for details. + * + * _Available since v3.4._ */ contract ERC20PresetFixedSupply is ERC20Burnable { /** diff --git a/contracts/presets/ERC777PresetFixedSupply.sol b/contracts/presets/ERC777PresetFixedSupply.sol index 5756b6498..3216668e2 100644 --- a/contracts/presets/ERC777PresetFixedSupply.sol +++ b/contracts/presets/ERC777PresetFixedSupply.sol @@ -8,6 +8,8 @@ import "../token/ERC777/ERC777.sol"; * * - Preminted initial supply * - No access control mechanism (for minting/pausing) and hence no governance + * + * _Available since v3.4._ */ contract ERC777PresetFixedSupply is ERC777 { /** diff --git a/contracts/proxy/BeaconProxy.sol b/contracts/proxy/BeaconProxy.sol index 3d6f10580..d2b715103 100644 --- a/contracts/proxy/BeaconProxy.sol +++ b/contracts/proxy/BeaconProxy.sol @@ -11,6 +11,8 @@ import "./IBeacon.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 { /** diff --git a/contracts/proxy/Clones.sol b/contracts/proxy/Clones.sol index 9ad5c223f..a789d05af 100644 --- a/contracts/proxy/Clones.sol +++ b/contracts/proxy/Clones.sol @@ -12,6 +12,8 @@ pragma solidity >=0.6.0 <0.8.0; * 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 { /** diff --git a/contracts/utils/Address.sol b/contracts/utils/Address.sol index 5d09d5edd..42a9dc1eb 100644 --- a/contracts/utils/Address.sol +++ b/contracts/utils/Address.sol @@ -148,7 +148,7 @@ library Address { * @dev Same as {xref-Address-functionCall-address-bytes-}[`functionCall`], * but performing a delegate call. * - * _Available since v3.3._ + * _Available since v3.4._ */ function functionDelegateCall(address target, bytes memory data) internal returns (bytes memory) { return functionDelegateCall(target, data, "Address: low-level delegate call failed"); @@ -158,7 +158,7 @@ library Address { * @dev Same as {xref-Address-functionCall-address-bytes-string-}[`functionCall`], * but performing a delegate call. * - * _Available since v3.3._ + * _Available since v3.4._ */ function functionDelegateCall(address target, bytes memory data, string memory errorMessage) internal returns (bytes memory) { require(isContract(target), "Address: delegate call to non-contract"); diff --git a/contracts/utils/EnumerableMap.sol b/contracts/utils/EnumerableMap.sol index 57bdabc40..a3e054cb1 100644 --- a/contracts/utils/EnumerableMap.sol +++ b/contracts/utils/EnumerableMap.sol @@ -235,6 +235,8 @@ library EnumerableMap { /** * @dev Tries to returns the value associated with `key`. O(1). * Does not revert if `key` is not in the map. + * + * _Available since v3.4._ */ function tryGet(UintToAddressMap storage map, uint256 key) internal view returns (bool, address) { (bool success, bytes32 value) = _tryGet(map._inner, bytes32(key));