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-12-07 21:55:12 +00:00
parent 57dd5968a7
commit 18704d1879
20 changed files with 134 additions and 138 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@ -384,7 +384,7 @@ Because Solidity does not support generic types, {EnumerableMap} and {Enumerable
[.contract]
[[Math]]
=== `++Math++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v5.0.0/contracts/utils/math/Math.sol[{github-icon},role=heading-link]
=== `++Math++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v5.0.1/contracts/utils/math/Math.sol[{github-icon},role=heading-link]
[.hljs-theme-light.nopadding]
```solidity
@ -571,7 +571,7 @@ Muldiv operation overflow.
[.contract]
[[SignedMath]]
=== `++SignedMath++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v5.0.0/contracts/utils/math/SignedMath.sol[{github-icon},role=heading-link]
=== `++SignedMath++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v5.0.1/contracts/utils/math/SignedMath.sol[{github-icon},role=heading-link]
[.hljs-theme-light.nopadding]
```solidity
@ -686,7 +686,7 @@ Returns the absolute unsigned value of a signed value.
[.contract]
[[SafeCast]]
=== `++SafeCast++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v5.0.0/contracts/utils/math/SafeCast.sol[{github-icon},role=heading-link]
=== `++SafeCast++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v5.0.1/contracts/utils/math/SafeCast.sol[{github-icon},role=heading-link]
[.hljs-theme-light.nopadding]
```solidity
@ -1680,7 +1680,7 @@ An uint value doesn't fit in an int of `bits` size.
[.contract]
[[ECDSA]]
=== `++ECDSA++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v5.0.0/contracts/utils/cryptography/ECDSA.sol[{github-icon},role=heading-link]
=== `++ECDSA++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v5.0.1/contracts/utils/cryptography/ECDSA.sol[{github-icon},role=heading-link]
[.hljs-theme-light.nopadding]
```solidity
@ -1807,7 +1807,7 @@ The signature has an S value that is in the upper half order.
[.contract]
[[MessageHashUtils]]
=== `++MessageHashUtils++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v5.0.0/contracts/utils/cryptography/MessageHashUtils.sol[{github-icon},role=heading-link]
=== `++MessageHashUtils++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v5.0.1/contracts/utils/cryptography/MessageHashUtils.sol[{github-icon},role=heading-link]
[.hljs-theme-light.nopadding]
```solidity
@ -1889,7 +1889,7 @@ See {ECDSA-recover}.
[.contract]
[[SignatureChecker]]
=== `++SignatureChecker++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v5.0.0/contracts/utils/cryptography/SignatureChecker.sol[{github-icon},role=heading-link]
=== `++SignatureChecker++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v5.0.1/contracts/utils/cryptography/SignatureChecker.sol[{github-icon},role=heading-link]
[.hljs-theme-light.nopadding]
```solidity
@ -1940,7 +1940,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/v5.0.0/contracts/utils/cryptography/MerkleProof.sol[{github-icon},role=heading-link]
=== `++MerkleProof++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v5.0.1/contracts/utils/cryptography/MerkleProof.sol[{github-icon},role=heading-link]
[.hljs-theme-light.nopadding]
```solidity
@ -2064,7 +2064,7 @@ The multiproof provided is not valid.
[.contract]
[[EIP712]]
=== `++EIP712++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v5.0.0/contracts/utils/cryptography/EIP712.sol[{github-icon},role=heading-link]
=== `++EIP712++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v5.0.1/contracts/utils/cryptography/EIP712.sol[{github-icon},role=heading-link]
[.hljs-theme-light.nopadding]
```solidity
@ -2189,7 +2189,7 @@ It only reads from storage if necessary (in case the value is too large to fit i
[.contract]
[[ReentrancyGuard]]
=== `++ReentrancyGuard++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v5.0.0/contracts/utils/ReentrancyGuard.sol[{github-icon},role=heading-link]
=== `++ReentrancyGuard++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v5.0.1/contracts/utils/ReentrancyGuard.sol[{github-icon},role=heading-link]
[.hljs-theme-light.nopadding]
```solidity
@ -2274,7 +2274,7 @@ Unauthorized reentrant call.
[.contract]
[[Pausable]]
=== `++Pausable++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v5.0.0/contracts/utils/Pausable.sol[{github-icon},role=heading-link]
=== `++Pausable++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v5.0.1/contracts/utils/Pausable.sol[{github-icon},role=heading-link]
[.hljs-theme-light.nopadding]
```solidity
@ -2422,7 +2422,7 @@ Ethereum contracts have no native concept of an interface, so applications must
[.contract]
[[IERC165]]
=== `++IERC165++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v5.0.0/contracts/utils/introspection/IERC165.sol[{github-icon},role=heading-link]
=== `++IERC165++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v5.0.1/contracts/utils/introspection/IERC165.sol[{github-icon},role=heading-link]
[.hljs-theme-light.nopadding]
```solidity
@ -2459,7 +2459,7 @@ This function call must use less than 30 000 gas.
[.contract]
[[ERC165]]
=== `++ERC165++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v5.0.0/contracts/utils/introspection/ERC165.sol[{github-icon},role=heading-link]
=== `++ERC165++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v5.0.1/contracts/utils/introspection/ERC165.sol[{github-icon},role=heading-link]
[.hljs-theme-light.nopadding]
```solidity
@ -2501,7 +2501,7 @@ See {IERC165-supportsInterface}.
[.contract]
[[ERC165Checker]]
=== `++ERC165Checker++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v5.0.0/contracts/utils/introspection/ERC165Checker.sol[{github-icon},role=heading-link]
=== `++ERC165Checker++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v5.0.1/contracts/utils/introspection/ERC165Checker.sol[{github-icon},role=heading-link]
[.hljs-theme-light.nopadding]
```solidity
@ -2586,7 +2586,7 @@ Interface identification is specified in ERC-165.
[.contract]
[[BitMaps]]
=== `++BitMaps++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v5.0.0/contracts/utils/structs/BitMaps.sol[{github-icon},role=heading-link]
=== `++BitMaps++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v5.0.1/contracts/utils/structs/BitMaps.sol[{github-icon},role=heading-link]
[.hljs-theme-light.nopadding]
```solidity
@ -2688,7 +2688,7 @@ Unsets the bit at `index`.
[.contract]
[[EnumerableMap]]
=== `++EnumerableMap++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v5.0.0/contracts/utils/structs/EnumerableMap.sol[{github-icon},role=heading-link]
=== `++EnumerableMap++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v5.0.1/contracts/utils/structs/EnumerableMap.sol[{github-icon},role=heading-link]
[.hljs-theme-light.nopadding]
```solidity
@ -3168,7 +3168,7 @@ Query for a nonexistent map key.
[.contract]
[[EnumerableSet]]
=== `++EnumerableSet++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v5.0.0/contracts/utils/structs/EnumerableSet.sol[{github-icon},role=heading-link]
=== `++EnumerableSet++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v5.0.1/contracts/utils/structs/EnumerableSet.sol[{github-icon},role=heading-link]
[.hljs-theme-light.nopadding]
```solidity
@ -3411,7 +3411,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/v5.0.0/contracts/utils/structs/DoubleEndedQueue.sol[{github-icon},role=heading-link]
=== `++DoubleEndedQueue++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v5.0.1/contracts/utils/structs/DoubleEndedQueue.sol[{github-icon},role=heading-link]
[.hljs-theme-light.nopadding]
```solidity
@ -3584,7 +3584,7 @@ An operation (e.g. {at}) couldn't be completed due to an index being out of boun
[.contract]
[[Checkpoints]]
=== `++Checkpoints++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v5.0.0/contracts/utils/structs/Checkpoints.sol[{github-icon},role=heading-link]
=== `++Checkpoints++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v5.0.1/contracts/utils/structs/Checkpoints.sol[{github-icon},role=heading-link]
[.hljs-theme-light.nopadding]
```solidity
@ -3831,7 +3831,7 @@ A value was attempted to be inserted on a past checkpoint.
[.contract]
[[Create2]]
=== `++Create2++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v5.0.0/contracts/utils/Create2.sol[{github-icon},role=heading-link]
=== `++Create2++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v5.0.1/contracts/utils/Create2.sol[{github-icon},role=heading-link]
[.hljs-theme-light.nopadding]
```solidity
@ -3926,7 +3926,7 @@ The deployment failed.
[.contract]
[[Address]]
=== `++Address++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v5.0.0/contracts/utils/Address.sol[{github-icon},role=heading-link]
=== `++Address++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v5.0.1/contracts/utils/Address.sol[{github-icon},role=heading-link]
[.hljs-theme-light.nopadding]
```solidity
@ -4065,7 +4065,7 @@ A call to an address target failed. The target may have reverted.
[.contract]
[[Arrays]]
=== `++Arrays++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v5.0.0/contracts/utils/Arrays.sol[{github-icon},role=heading-link]
=== `++Arrays++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v5.0.1/contracts/utils/Arrays.sol[{github-icon},role=heading-link]
[.hljs-theme-light.nopadding]
```solidity
@ -4143,7 +4143,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/v5.0.0/contracts/utils/Base64.sol[{github-icon},role=heading-link]
=== `++Base64++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v5.0.1/contracts/utils/Base64.sol[{github-icon},role=heading-link]
[.hljs-theme-light.nopadding]
```solidity
@ -4175,7 +4175,7 @@ Converts a `bytes` to its Bytes64 `string` representation.
[.contract]
[[Strings]]
=== `++Strings++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v5.0.0/contracts/utils/Strings.sol[{github-icon},role=heading-link]
=== `++Strings++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v5.0.1/contracts/utils/Strings.sol[{github-icon},role=heading-link]
[.hljs-theme-light.nopadding]
```solidity
@ -4257,7 +4257,7 @@ The `value` string doesn't fit in the specified `length`.
[.contract]
[[ShortStrings]]
=== `++ShortStrings++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v5.0.0/contracts/utils/ShortStrings.sol[{github-icon},role=heading-link]
=== `++ShortStrings++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v5.0.1/contracts/utils/ShortStrings.sol[{github-icon},role=heading-link]
[.hljs-theme-light.nopadding]
```solidity
@ -4378,7 +4378,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/v5.0.0/contracts/utils/StorageSlot.sol[{github-icon},role=heading-link]
=== `++StorageSlot++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v5.0.1/contracts/utils/StorageSlot.sol[{github-icon},role=heading-link]
[.hljs-theme-light.nopadding]
```solidity
@ -4474,7 +4474,7 @@ Returns an `BytesSlot` representation of the bytes storage pointer `store`.
[.contract]
[[Multicall]]
=== `++Multicall++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v5.0.0/contracts/utils/Multicall.sol[{github-icon},role=heading-link]
=== `++Multicall++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v5.0.1/contracts/utils/Multicall.sol[{github-icon},role=heading-link]
[.hljs-theme-light.nopadding]
```solidity