NoBey/openzeppelin-contracts
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Improve some NatSpec (#3809)

Browse Source 
Co-authored-by: JulissaDantes <julissadcj@gmail.com>
(cherry picked from commit 8f8fd84f1e)
This commit is contained in:
Francisco
2022-11-25 12:55:16 -03:00
committed by Francisco Giordano
parent 49c0e4370d
commit 53eb531255
4 changed files with 33 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
contracts/utils/Checkpoints.sol
View File

@ -28,7 +28,8 @@ library Checkpoints {
/**
* @dev Returns the value at a given block number. If a checkpoint is not available at that block, the closest one
* before it is returned, or zero otherwise.
* before it is returned, or zero otherwise. Because the number returned corresponds to that at the end of the
* block, the requested block number must be in the past, excluding the current block.
*/
function getAtBlock(History storage self, uint256 blockNumber) internal view returns (uint256) {
require(blockNumber < block.number, "Checkpoints: block not yet mined");
@ -205,6 +206,9 @@ library Checkpoints {
return high;
}
/**
* @dev Access an element of the array without performing bounds check. The position is assumed to be within bounds.
*/
function _unsafeAccess(Checkpoint[] storage self, uint256 pos) private pure returns (Checkpoint storage result) {
assembly {
mstore(0, self.slot)
@ -366,6 +370,9 @@ library Checkpoints {
return high;
}
/**
* @dev Access an element of the array without performing bounds check. The position is assumed to be within bounds.
*/
function _unsafeAccess(Checkpoint224[] storage self, uint256 pos)
private
pure
@ -531,6 +538,9 @@ library Checkpoints {
return high;
}
/**
* @dev Access an element of the array without performing bounds check. The position is assumed to be within bounds.
*/
function _unsafeAccess(Checkpoint160[] storage self, uint256 pos)
private
pure