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

Update docs

Browse Source
This commit is contained in:
github-actions
2023-05-23 18:18:00 +00:00
parent 6ae39c4dc1
commit cf52c4a0a5
158 changed files with 331 additions and 470 deletions
Download Patch File Download Diff File Expand all files Collapse all files

66
docs/modules/api/pages/utils.adoc
View File

@ -439,7 +439,7 @@ Finally, {Create2} contains all necessary utilities to safely use the https://bl
[.contract]
[[Math]]
=== `++Math++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v4.8.2/contracts/utils/math/Math.sol[{github-icon},role=heading-link]
=== `++Math++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v4.9.0/contracts/utils/math/Math.sol[{github-icon},role=heading-link]
[.hljs-theme-light.nopadding]
```solidity
@ -570,7 +570,7 @@ Returns 0 if given 0.
[.contract]
[[SignedMath]]
=== `++SignedMath++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v4.8.2/contracts/utils/math/SignedMath.sol[{github-icon},role=heading-link]
=== `++SignedMath++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v4.9.0/contracts/utils/math/SignedMath.sol[{github-icon},role=heading-link]
[.hljs-theme-light.nopadding]
```solidity
@ -681,7 +681,7 @@ Returns the absolute unsigned value of a signed value.
[.contract]
[[SafeCast]]
=== `++SafeCast++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v4.8.2/contracts/utils/math/SafeCast.sol[{github-icon},role=heading-link]
=== `++SafeCast++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v4.9.0/contracts/utils/math/SafeCast.sol[{github-icon},role=heading-link]
[.hljs-theme-light.nopadding]
```solidity
@ -1773,7 +1773,7 @@ _Available since v3.0._
[.contract]
[[SafeMath]]
=== `++SafeMath++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v4.8.2/contracts/utils/math/SafeMath.sol[{github-icon},role=heading-link]
=== `++SafeMath++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v4.9.0/contracts/utils/math/SafeMath.sol[{github-icon},role=heading-link]
[.hljs-theme-light.nopadding]
```solidity
@ -1967,7 +1967,7 @@ Requirements:
[.contract]
[[SignedSafeMath]]
=== `++SignedSafeMath++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v4.8.2/contracts/utils/math/SignedSafeMath.sol[{github-icon},role=heading-link]
=== `++SignedSafeMath++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v4.9.0/contracts/utils/math/SignedSafeMath.sol[{github-icon},role=heading-link]
[.hljs-theme-light.nopadding]
```solidity
@ -2057,7 +2057,7 @@ Requirements:
[.contract]
[[ECDSA]]
=== `++ECDSA++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v4.8.2/contracts/utils/cryptography/ECDSA.sol[{github-icon},role=heading-link]
=== `++ECDSA++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v4.9.0/contracts/utils/cryptography/ECDSA.sol[{github-icon},role=heading-link]
[.hljs-theme-light.nopadding]
```solidity
@ -2207,7 +2207,7 @@ See {recover}.
[.contract]
[[SignatureChecker]]
=== `++SignatureChecker++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v4.8.2/contracts/utils/cryptography/SignatureChecker.sol[{github-icon},role=heading-link]
=== `++SignatureChecker++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v4.9.0/contracts/utils/cryptography/SignatureChecker.sol[{github-icon},role=heading-link]
[.hljs-theme-light.nopadding]
```solidity
@ -2259,7 +2259,7 @@ change through time. It could return true at block N and false at block N+1 (or
[.contract]
[[MerkleProof]]
=== `++MerkleProof++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v4.8.2/contracts/utils/cryptography/MerkleProof.sol[{github-icon},role=heading-link]
=== `++MerkleProof++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v4.9.0/contracts/utils/cryptography/MerkleProof.sol[{github-icon},role=heading-link]
[.hljs-theme-light.nopadding]
```solidity
@ -2382,7 +2382,7 @@ _Available since v4.7._
[.contract]
[[EIP712]]
=== `++EIP712++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v4.8.2/contracts/utils/cryptography/EIP712.sol[{github-icon},role=heading-link]
=== `++EIP712++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v4.9.0/contracts/utils/cryptography/EIP712.sol[{github-icon},role=heading-link]
[.hljs-theme-light.nopadding]
```solidity
@ -2488,7 +2488,7 @@ _Available since v4.9._
[.contract]
[[ConditionalEscrow]]
=== `++ConditionalEscrow++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v4.8.2/contracts/utils/escrow/ConditionalEscrow.sol[{github-icon},role=heading-link]
=== `++ConditionalEscrow++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v4.9.0/contracts/utils/escrow/ConditionalEscrow.sol[{github-icon},role=heading-link]
[.hljs-theme-light.nopadding]
```solidity
@ -2560,7 +2560,7 @@ checks-effects-interactions pattern or using {ReentrancyGuard}.
[.contract]
[[Escrow]]
=== `++Escrow++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v4.8.2/contracts/utils/escrow/Escrow.sol[{github-icon},role=heading-link]
=== `++Escrow++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v4.9.0/contracts/utils/escrow/Escrow.sol[{github-icon},role=heading-link]
[.hljs-theme-light.nopadding]
```solidity
@ -2650,7 +2650,7 @@ checks-effects-interactions pattern or using {ReentrancyGuard}.
[.contract]
[[RefundEscrow]]
=== `++RefundEscrow++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v4.8.2/contracts/utils/escrow/RefundEscrow.sol[{github-icon},role=heading-link]
=== `++RefundEscrow++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v4.9.0/contracts/utils/escrow/RefundEscrow.sol[{github-icon},role=heading-link]
[.hljs-theme-light.nopadding]
```solidity
@ -2786,7 +2786,7 @@ Note that, in all cases, accounts simply _declare_ their interfaces, but they ar
[.contract]
[[IERC165]]
=== `++IERC165++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v4.8.2/contracts/utils/introspection/IERC165.sol[{github-icon},role=heading-link]
=== `++IERC165++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v4.9.0/contracts/utils/introspection/IERC165.sol[{github-icon},role=heading-link]
[.hljs-theme-light.nopadding]
```solidity
@ -2823,7 +2823,7 @@ This function call must use less than 30 000 gas.
[.contract]
[[ERC165]]
=== `++ERC165++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v4.8.2/contracts/utils/introspection/ERC165.sol[{github-icon},role=heading-link]
=== `++ERC165++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v4.9.0/contracts/utils/introspection/ERC165.sol[{github-icon},role=heading-link]
[.hljs-theme-light.nopadding]
```solidity
@ -2864,7 +2864,7 @@ See {IERC165-supportsInterface}.
[.contract]
[[ERC165Storage]]
=== `++ERC165Storage++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v4.8.2/contracts/utils/introspection/ERC165Storage.sol[{github-icon},role=heading-link]
=== `++ERC165Storage++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v4.9.0/contracts/utils/introspection/ERC165Storage.sol[{github-icon},role=heading-link]
[.hljs-theme-light.nopadding]
```solidity
@ -2918,7 +2918,7 @@ Requirements:
[.contract]
[[ERC165Checker]]
=== `++ERC165Checker++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v4.8.2/contracts/utils/introspection/ERC165Checker.sol[{github-icon},role=heading-link]
=== `++ERC165Checker++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v4.9.0/contracts/utils/introspection/ERC165Checker.sol[{github-icon},role=heading-link]
[.hljs-theme-light.nopadding]
```solidity
@ -3008,7 +3008,7 @@ Interface identification is specified in ERC-165.
[.contract]
[[IERC1820Registry]]
=== `++IERC1820Registry++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v4.8.2/contracts/utils/introspection/IERC1820Registry.sol[{github-icon},role=heading-link]
=== `++IERC1820Registry++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v4.9.0/contracts/utils/introspection/IERC1820Registry.sol[{github-icon},role=heading-link]
[.hljs-theme-light.nopadding]
```solidity
@ -3141,7 +3141,7 @@ https://eips.ethereum.org/EIPS/eip-1820#interface-name[section of the EIP].
[.contract]
[[IERC1820Implementer]]
=== `++IERC1820Implementer++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v4.8.2/contracts/utils/introspection/IERC1820Implementer.sol[{github-icon},role=heading-link]
=== `++IERC1820Implementer++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v4.9.0/contracts/utils/introspection/IERC1820Implementer.sol[{github-icon},role=heading-link]
[.hljs-theme-light.nopadding]
```solidity
@ -3174,7 +3174,7 @@ See {IERC1820Registry-setInterfaceImplementer}.
[.contract]
[[ERC1820Implementer]]
=== `++ERC1820Implementer++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v4.8.2/contracts/utils/introspection/ERC1820Implementer.sol[{github-icon},role=heading-link]
=== `++ERC1820Implementer++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v4.9.0/contracts/utils/introspection/ERC1820Implementer.sol[{github-icon},role=heading-link]
[.hljs-theme-light.nopadding]
```solidity
@ -3227,7 +3227,7 @@ See {IERC1820Registry-setInterfaceImplementer} and
[.contract]
[[BitMaps]]
=== `++BitMaps++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v4.8.2/contracts/utils/structs/BitMaps.sol[{github-icon},role=heading-link]
=== `++BitMaps++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v4.9.0/contracts/utils/structs/BitMaps.sol[{github-icon},role=heading-link]
[.hljs-theme-light.nopadding]
```solidity
@ -3324,7 +3324,7 @@ Unsets the bit at `index`.
[.contract]
[[EnumerableMap]]
=== `++EnumerableMap++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v4.8.2/contracts/utils/structs/EnumerableMap.sol[{github-icon},role=heading-link]
=== `++EnumerableMap++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v4.9.0/contracts/utils/structs/EnumerableMap.sol[{github-icon},role=heading-link]
[.hljs-theme-light.nopadding]
```solidity
@ -3841,7 +3841,7 @@ uncallable if the map grows to a point where copying to memory consumes too much
[.contract]
[[EnumerableSet]]
=== `++EnumerableSet++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v4.8.2/contracts/utils/structs/EnumerableSet.sol[{github-icon},role=heading-link]
=== `++EnumerableSet++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v4.9.0/contracts/utils/structs/EnumerableSet.sol[{github-icon},role=heading-link]
[.hljs-theme-light.nopadding]
```solidity
@ -4083,7 +4083,7 @@ uncallable if the set grows to a point where copying to memory consumes too much
[.contract]
[[DoubleEndedQueue]]
=== `++DoubleEndedQueue++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v4.8.2/contracts/utils/structs/DoubleEndedQueue.sol[{github-icon},role=heading-link]
=== `++DoubleEndedQueue++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v4.9.0/contracts/utils/structs/DoubleEndedQueue.sol[{github-icon},role=heading-link]
[.hljs-theme-light.nopadding]
```solidity
@ -4223,7 +4223,7 @@ Returns true if the queue is empty.
[.contract]
[[Checkpoints]]
=== `++Checkpoints++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v4.8.2/contracts/utils/Checkpoints.sol[{github-icon},role=heading-link]
=== `++Checkpoints++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v4.9.0/contracts/utils/Checkpoints.sol[{github-icon},role=heading-link]
[.hljs-theme-light.nopadding]
```solidity
@ -4420,7 +4420,7 @@ Returns the number of checkpoint.
[.contract]
[[Create2]]
=== `++Create2++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v4.8.2/contracts/utils/Create2.sol[{github-icon},role=heading-link]
=== `++Create2++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v4.9.0/contracts/utils/Create2.sol[{github-icon},role=heading-link]
[.hljs-theme-light.nopadding]
```solidity
@ -4490,7 +4490,7 @@ Returns the address where a contract will be stored if deployed via {deploy} fro
[.contract]
[[Address]]
=== `++Address++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v4.8.2/contracts/utils/Address.sol[{github-icon},role=heading-link]
=== `++Address++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v4.9.0/contracts/utils/Address.sol[{github-icon},role=heading-link]
[.hljs-theme-light.nopadding]
```solidity
@ -4683,7 +4683,7 @@ _Available since v4.3._
[.contract]
[[Arrays]]
=== `++Arrays++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v4.8.2/contracts/utils/Arrays.sol[{github-icon},role=heading-link]
=== `++Arrays++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v4.9.0/contracts/utils/Arrays.sol[{github-icon},role=heading-link]
[.hljs-theme-light.nopadding]
```solidity
@ -4743,7 +4743,7 @@ WARNING: Only use if you are certain `pos` is lower than the array length.
[.contract]
[[Base64]]
=== `++Base64++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v4.8.2/contracts/utils/Base64.sol[{github-icon},role=heading-link]
=== `++Base64++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v4.9.0/contracts/utils/Base64.sol[{github-icon},role=heading-link]
[.hljs-theme-light.nopadding]
```solidity
@ -4775,7 +4775,7 @@ Converts a `bytes` to its Bytes64 `string` representation.
[.contract]
[[Counters]]
=== `++Counters++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v4.8.2/contracts/utils/Counters.sol[{github-icon},role=heading-link]
=== `++Counters++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v4.9.0/contracts/utils/Counters.sol[{github-icon},role=heading-link]
[.hljs-theme-light.nopadding]
```solidity
@ -4822,7 +4822,7 @@ Include with `using Counters for Counters.Counter;`
[.contract]
[[Strings]]
=== `++Strings++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v4.8.2/contracts/utils/Strings.sol[{github-icon},role=heading-link]
=== `++Strings++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v4.9.0/contracts/utils/Strings.sol[{github-icon},role=heading-link]
[.hljs-theme-light.nopadding]
```solidity
@ -4890,7 +4890,7 @@ Returns true if the two strings are equal.
[.contract]
[[ShortStrings]]
=== `++ShortStrings++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v4.8.2/contracts/utils/ShortStrings.sol[{github-icon},role=heading-link]
=== `++ShortStrings++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v4.9.0/contracts/utils/ShortStrings.sol[{github-icon},role=heading-link]
[.hljs-theme-light.nopadding]
```solidity
@ -4994,7 +4994,7 @@ actual characters as the UTF-8 encoding of a single character can span over mult
[.contract]
[[StorageSlot]]
=== `++StorageSlot++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v4.8.2/contracts/utils/StorageSlot.sol[{github-icon},role=heading-link]
=== `++StorageSlot++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v4.9.0/contracts/utils/StorageSlot.sol[{github-icon},role=heading-link]
[.hljs-theme-light.nopadding]
```solidity
@ -5093,7 +5093,7 @@ Returns an `BytesSlot` representation of the bytes storage pointer `store`.
[.contract]
[[Multicall]]
=== `++Multicall++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v4.8.2/contracts/utils/Multicall.sol[{github-icon},role=heading-link]
=== `++Multicall++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v4.9.0/contracts/utils/Multicall.sol[{github-icon},role=heading-link]
[.hljs-theme-light.nopadding]
```solidity