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-09-28 23:41:33 +00:00
parent add444d448
commit 801b74738d
24 changed files with 139 additions and 130 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
docs/modules/api/pages/token/ERC1155.adoc
View File

@ -259,7 +259,7 @@ NOTE: This core set of contracts is designed to be unopinionated, allowing devel
[.contract]
[[IERC1155]]
=== `++IERC1155++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v5.0.0-rc.0/contracts/token/ERC1155/IERC1155.sol[{github-icon},role=heading-link]
=== `++IERC1155++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v5.0.0-rc.1/contracts/token/ERC1155/IERC1155.sol[{github-icon},role=heading-link]
[.hljs-theme-light.nopadding]
```solidity
@ -412,7 +412,7 @@ returned by {IERC1155MetadataURI-uri}.
[.contract]
[[IERC1155MetadataURI]]
=== `++IERC1155MetadataURI++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v5.0.0-rc.0/contracts/token/ERC1155/extensions/IERC1155MetadataURI.sol[{github-icon},role=heading-link]
=== `++IERC1155MetadataURI++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v5.0.0-rc.1/contracts/token/ERC1155/extensions/IERC1155MetadataURI.sol[{github-icon},role=heading-link]
[.hljs-theme-light.nopadding]
```solidity
@ -489,7 +489,7 @@ clients with the actual token type ID.
[.contract]
[[ERC1155]]
=== `++ERC1155++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v5.0.0-rc.0/contracts/token/ERC1155/ERC1155.sol[{github-icon},role=heading-link]
=== `++ERC1155++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v5.0.0-rc.1/contracts/token/ERC1155/ERC1155.sol[{github-icon},role=heading-link]
[.hljs-theme-light.nopadding]
```solidity
@ -811,7 +811,7 @@ Requirements:
[.contract]
[[IERC1155Receiver]]
=== `++IERC1155Receiver++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v5.0.0-rc.0/contracts/token/ERC1155/IERC1155Receiver.sol[{github-icon},role=heading-link]
=== `++IERC1155Receiver++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v5.0.0-rc.1/contracts/token/ERC1155/IERC1155Receiver.sol[{github-icon},role=heading-link]
[.hljs-theme-light.nopadding]
```solidity
@ -862,7 +862,7 @@ NOTE: To accept the transfer(s), this must return
[.contract]
[[ERC1155Pausable]]
=== `++ERC1155Pausable++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v5.0.0-rc.0/contracts/token/ERC1155/extensions/ERC1155Pausable.sol[{github-icon},role=heading-link]
=== `++ERC1155Pausable++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v5.0.0-rc.1/contracts/token/ERC1155/extensions/ERC1155Pausable.sol[{github-icon},role=heading-link]
[.hljs-theme-light.nopadding]
```solidity
@ -1015,7 +1015,7 @@ Requirements:
[.contract]
[[ERC1155Burnable]]
=== `++ERC1155Burnable++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v5.0.0-rc.0/contracts/token/ERC1155/extensions/ERC1155Burnable.sol[{github-icon},role=heading-link]
=== `++ERC1155Burnable++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v5.0.0-rc.1/contracts/token/ERC1155/extensions/ERC1155Burnable.sol[{github-icon},role=heading-link]
[.hljs-theme-light.nopadding]
```solidity
@ -1143,7 +1143,7 @@ own tokens and those that they have been approved to use.
[.contract]
[[ERC1155Supply]]
=== `++ERC1155Supply++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v5.0.0-rc.0/contracts/token/ERC1155/extensions/ERC1155Supply.sol[{github-icon},role=heading-link]
=== `++ERC1155Supply++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v5.0.0-rc.1/contracts/token/ERC1155/extensions/ERC1155Supply.sol[{github-icon},role=heading-link]
[.hljs-theme-light.nopadding]
```solidity
@ -1296,7 +1296,7 @@ See {ERC1155-_update}.
[.contract]
[[ERC1155URIStorage]]
=== `++ERC1155URIStorage++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v5.0.0-rc.0/contracts/token/ERC1155/extensions/ERC1155URIStorage.sol[{github-icon},role=heading-link]
=== `++ERC1155URIStorage++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v5.0.0-rc.1/contracts/token/ERC1155/extensions/ERC1155URIStorage.sol[{github-icon},role=heading-link]
[.hljs-theme-light.nopadding]
```solidity
@ -1450,7 +1450,7 @@ Sets `baseURI` as the `_baseURI` for all tokens
[.contract]
[[ERC1155Holder]]
=== `++ERC1155Holder++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v5.0.0-rc.0/contracts/token/ERC1155/utils/ERC1155Holder.sol[{github-icon},role=heading-link]
=== `++ERC1155Holder++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v5.0.0-rc.1/contracts/token/ERC1155/utils/ERC1155Holder.sol[{github-icon},role=heading-link]
[.hljs-theme-light.nopadding]
```solidity

26
docs/modules/api/pages/token/ERC20.adoc
View File

@ -468,7 +468,7 @@ NOTE: This core set of contracts is designed to be unopinionated, allowing devel
[.contract]
[[IERC20]]
=== `++IERC20++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v5.0.0-rc.0/contracts/token/ERC20/IERC20.sol[{github-icon},role=heading-link]
=== `++IERC20++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v5.0.0-rc.1/contracts/token/ERC20/IERC20.sol[{github-icon},role=heading-link]
[.hljs-theme-light.nopadding]
```solidity
@ -581,7 +581,7 @@ a call to {approve}. `value` is the new allowance.
[.contract]
[[IERC20Metadata]]
=== `++IERC20Metadata++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v5.0.0-rc.0/contracts/token/ERC20/extensions/IERC20Metadata.sol[{github-icon},role=heading-link]
=== `++IERC20Metadata++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v5.0.0-rc.1/contracts/token/ERC20/extensions/IERC20Metadata.sol[{github-icon},role=heading-link]
[.hljs-theme-light.nopadding]
```solidity
@ -657,7 +657,7 @@ Returns the decimals places of the token.
[.contract]
[[ERC20]]
=== `++ERC20++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v5.0.0-rc.0/contracts/token/ERC20/ERC20.sol[{github-icon},role=heading-link]
=== `++ERC20++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v5.0.0-rc.1/contracts/token/ERC20/ERC20.sol[{github-icon},role=heading-link]
[.hljs-theme-light.nopadding]
```solidity
@ -957,7 +957,7 @@ Does not emit an {Approval} event.
[.contract]
[[IERC20Permit]]
=== `++IERC20Permit++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v5.0.0-rc.0/contracts/token/ERC20/extensions/IERC20Permit.sol[{github-icon},role=heading-link]
=== `++IERC20Permit++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v5.0.0-rc.1/contracts/token/ERC20/extensions/IERC20Permit.sol[{github-icon},role=heading-link]
[.hljs-theme-light.nopadding]
```solidity
@ -1059,7 +1059,7 @@ Returns the domain separator used in the encoding of the signature for {permit},
[.contract]
[[ERC20Permit]]
=== `++ERC20Permit++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v5.0.0-rc.0/contracts/token/ERC20/extensions/ERC20Permit.sol[{github-icon},role=heading-link]
=== `++ERC20Permit++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v5.0.0-rc.1/contracts/token/ERC20/extensions/ERC20Permit.sol[{github-icon},role=heading-link]
[.hljs-theme-light.nopadding]
```solidity
@ -1269,7 +1269,7 @@ Mismatched signature.
[.contract]
[[ERC20Burnable]]
=== `++ERC20Burnable++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v5.0.0-rc.0/contracts/token/ERC20/extensions/ERC20Burnable.sol[{github-icon},role=heading-link]
=== `++ERC20Burnable++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v5.0.0-rc.1/contracts/token/ERC20/extensions/ERC20Burnable.sol[{github-icon},role=heading-link]
[.hljs-theme-light.nopadding]
```solidity
@ -1390,7 +1390,7 @@ Requirements:
[.contract]
[[ERC20Capped]]
=== `++ERC20Capped++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v5.0.0-rc.0/contracts/token/ERC20/extensions/ERC20Capped.sol[{github-icon},role=heading-link]
=== `++ERC20Capped++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v5.0.0-rc.1/contracts/token/ERC20/extensions/ERC20Capped.sol[{github-icon},role=heading-link]
[.hljs-theme-light.nopadding]
```solidity
@ -1516,7 +1516,7 @@ The supplied cap is not a valid cap.
[.contract]
[[ERC20Pausable]]
=== `++ERC20Pausable++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v5.0.0-rc.0/contracts/token/ERC20/extensions/ERC20Pausable.sol[{github-icon},role=heading-link]
=== `++ERC20Pausable++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v5.0.0-rc.1/contracts/token/ERC20/extensions/ERC20Pausable.sol[{github-icon},role=heading-link]
[.hljs-theme-light.nopadding]
```solidity
@ -1650,7 +1650,7 @@ Requirements:
[.contract]
[[ERC20Votes]]
=== `++ERC20Votes++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v5.0.0-rc.0/contracts/token/ERC20/extensions/ERC20Votes.sol[{github-icon},role=heading-link]
=== `++ERC20Votes++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v5.0.0-rc.1/contracts/token/ERC20/extensions/ERC20Votes.sol[{github-icon},role=heading-link]
[.hljs-theme-light.nopadding]
```solidity
@ -1901,7 +1901,7 @@ Total supply cap has been exceeded, introducing a risk of votes overflowing.
[.contract]
[[ERC20Wrapper]]
=== `++ERC20Wrapper++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v5.0.0-rc.0/contracts/token/ERC20/extensions/ERC20Wrapper.sol[{github-icon},role=heading-link]
=== `++ERC20Wrapper++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v5.0.0-rc.1/contracts/token/ERC20/extensions/ERC20Wrapper.sol[{github-icon},role=heading-link]
[.hljs-theme-light.nopadding]
```solidity
@ -2050,7 +2050,7 @@ The underlying token couldn't be wrapped.
[.contract]
[[ERC20FlashMint]]
=== `++ERC20FlashMint++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v5.0.0-rc.0/contracts/token/ERC20/extensions/ERC20FlashMint.sol[{github-icon},role=heading-link]
=== `++ERC20FlashMint++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v5.0.0-rc.1/contracts/token/ERC20/extensions/ERC20FlashMint.sol[{github-icon},role=heading-link]
[.hljs-theme-light.nopadding]
```solidity
@ -2250,7 +2250,7 @@ The receiver of a flashloan is not a valid {onFlashLoan} implementer.
[.contract]
[[ERC4626]]
=== `++ERC4626++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v5.0.0-rc.0/contracts/token/ERC20/extensions/ERC4626.sol[{github-icon},role=heading-link]
=== `++ERC4626++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v5.0.0-rc.1/contracts/token/ERC20/extensions/ERC4626.sol[{github-icon},role=heading-link]
[.hljs-theme-light.nopadding]
```solidity
@ -2587,7 +2587,7 @@ Attempted to redeem more shares than the max amount for `receiver`.
[.contract]
[[SafeERC20]]
=== `++SafeERC20++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v5.0.0-rc.0/contracts/token/ERC20/utils/SafeERC20.sol[{github-icon},role=heading-link]
=== `++SafeERC20++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v5.0.0-rc.1/contracts/token/ERC20/utils/SafeERC20.sol[{github-icon},role=heading-link]
[.hljs-theme-light.nopadding]
```solidity

28
docs/modules/api/pages/token/ERC721.adoc
View File

@ -623,7 +623,7 @@ NOTE: This core set of contracts is designed to be unopinionated, allowing devel
[.contract]
[[IERC721]]
=== `++IERC721++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v5.0.0-rc.0/contracts/token/ERC721/IERC721.sol[{github-icon},role=heading-link]
=== `++IERC721++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v5.0.0-rc.1/contracts/token/ERC721/IERC721.sol[{github-icon},role=heading-link]
[.hljs-theme-light.nopadding]
```solidity
@ -805,7 +805,7 @@ Emitted when `owner` enables or disables (`approved`) `operator` to manage all o
[.contract]
[[IERC721Metadata]]
=== `++IERC721Metadata++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v5.0.0-rc.0/contracts/token/ERC721/extensions/IERC721Metadata.sol[{github-icon},role=heading-link]
=== `++IERC721Metadata++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v5.0.0-rc.1/contracts/token/ERC721/extensions/IERC721Metadata.sol[{github-icon},role=heading-link]
[.hljs-theme-light.nopadding]
```solidity
@ -878,7 +878,7 @@ Returns the Uniform Resource Identifier (URI) for `tokenId` token.
[.contract]
[[IERC721Enumerable]]
=== `++IERC721Enumerable++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v5.0.0-rc.0/contracts/token/ERC721/extensions/IERC721Enumerable.sol[{github-icon},role=heading-link]
=== `++IERC721Enumerable++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v5.0.0-rc.1/contracts/token/ERC721/extensions/IERC721Enumerable.sol[{github-icon},role=heading-link]
[.hljs-theme-light.nopadding]
```solidity
@ -982,7 +982,7 @@ Use along with {totalSupply} to enumerate all tokens.
[.contract]
[[ERC721]]
=== `++ERC721++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v5.0.0-rc.0/contracts/token/ERC721/ERC721.sol[{github-icon},role=heading-link]
=== `++ERC721++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v5.0.0-rc.1/contracts/token/ERC721/ERC721.sol[{github-icon},role=heading-link]
[.hljs-theme-light.nopadding]
```solidity
@ -1399,7 +1399,7 @@ Overrides to ownership logic should be done to {_ownerOf}.
[.contract]
[[ERC721Enumerable]]
=== `++ERC721Enumerable++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v5.0.0-rc.0/contracts/token/ERC721/extensions/ERC721Enumerable.sol[{github-icon},role=heading-link]
=== `++ERC721Enumerable++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v5.0.0-rc.1/contracts/token/ERC721/extensions/ERC721Enumerable.sol[{github-icon},role=heading-link]
[.hljs-theme-light.nopadding]
```solidity
@ -1592,7 +1592,7 @@ Batch mint is not allowed.
[.contract]
[[IERC721Receiver]]
=== `++IERC721Receiver++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v5.0.0-rc.0/contracts/token/ERC721/IERC721Receiver.sol[{github-icon},role=heading-link]
=== `++IERC721Receiver++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v5.0.0-rc.1/contracts/token/ERC721/IERC721Receiver.sol[{github-icon},role=heading-link]
[.hljs-theme-light.nopadding]
```solidity
@ -1628,7 +1628,7 @@ The selector can be obtained in Solidity with `IERC721Receiver.onERC721Received.
[.contract]
[[ERC721Pausable]]
=== `++ERC721Pausable++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v5.0.0-rc.0/contracts/token/ERC721/extensions/ERC721Pausable.sol[{github-icon},role=heading-link]
=== `++ERC721Pausable++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v5.0.0-rc.1/contracts/token/ERC721/extensions/ERC721Pausable.sol[{github-icon},role=heading-link]
[.hljs-theme-light.nopadding]
```solidity
@ -1793,7 +1793,7 @@ Requirements:
[.contract]
[[ERC721Burnable]]
=== `++ERC721Burnable++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v5.0.0-rc.0/contracts/token/ERC721/extensions/ERC721Burnable.sol[{github-icon},role=heading-link]
=== `++ERC721Burnable++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v5.0.0-rc.1/contracts/token/ERC721/extensions/ERC721Burnable.sol[{github-icon},role=heading-link]
[.hljs-theme-light.nopadding]
```solidity
@ -1939,7 +1939,7 @@ Requirements:
[.contract]
[[ERC721Consecutive]]
=== `++ERC721Consecutive++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v5.0.0-rc.0/contracts/token/ERC721/extensions/ERC721Consecutive.sol[{github-icon},role=heading-link]
=== `++ERC721Consecutive++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v5.0.0-rc.1/contracts/token/ERC721/extensions/ERC721Consecutive.sol[{github-icon},role=heading-link]
[.hljs-theme-light.nopadding]
```solidity
@ -2179,7 +2179,7 @@ Batch burn is not supported.
[.contract]
[[ERC721URIStorage]]
=== `++ERC721URIStorage++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v5.0.0-rc.0/contracts/token/ERC721/extensions/ERC721URIStorage.sol[{github-icon},role=heading-link]
=== `++ERC721URIStorage++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v5.0.0-rc.1/contracts/token/ERC721/extensions/ERC721URIStorage.sol[{github-icon},role=heading-link]
[.hljs-theme-light.nopadding]
```solidity
@ -2340,7 +2340,7 @@ Emits {MetadataUpdate}.
[.contract]
[[ERC721Votes]]
=== `++ERC721Votes++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v5.0.0-rc.0/contracts/token/ERC721/extensions/ERC721Votes.sol[{github-icon},role=heading-link]
=== `++ERC721Votes++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v5.0.0-rc.1/contracts/token/ERC721/extensions/ERC721Votes.sol[{github-icon},role=heading-link]
[.hljs-theme-light.nopadding]
```solidity
@ -2586,7 +2586,7 @@ See {ERC721-_increaseBalance}. We need that to account tokens that were minted i
[.contract]
[[ERC721Royalty]]
=== `++ERC721Royalty++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v5.0.0-rc.0/contracts/token/ERC721/extensions/ERC721Royalty.sol[{github-icon},role=heading-link]
=== `++ERC721Royalty++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v5.0.0-rc.1/contracts/token/ERC721/extensions/ERC721Royalty.sol[{github-icon},role=heading-link]
[.hljs-theme-light.nopadding]
```solidity
@ -2761,7 +2761,7 @@ See {IERC165-supportsInterface}.
[.contract]
[[ERC721Wrapper]]
=== `++ERC721Wrapper++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v5.0.0-rc.0/contracts/token/ERC721/extensions/ERC721Wrapper.sol[{github-icon},role=heading-link]
=== `++ERC721Wrapper++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v5.0.0-rc.1/contracts/token/ERC721/extensions/ERC721Wrapper.sol[{github-icon},role=heading-link]
[.hljs-theme-light.nopadding]
```solidity
@ -2958,7 +2958,7 @@ The received ERC721 token couldn't be wrapped.
[.contract]
[[ERC721Holder]]
=== `++ERC721Holder++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v5.0.0-rc.0/contracts/token/ERC721/utils/ERC721Holder.sol[{github-icon},role=heading-link]
=== `++ERC721Holder++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v5.0.0-rc.1/contracts/token/ERC721/utils/ERC721Holder.sol[{github-icon},role=heading-link]
[.hljs-theme-light.nopadding]
```solidity

2
docs/modules/api/pages/token/common.adoc
View File

@ -37,7 +37,7 @@ Functionality that is common to multiple token standards.
[.contract]
[[ERC2981]]
=== `++ERC2981++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v5.0.0-rc.0/contracts/token/common/ERC2981.sol[{github-icon},role=heading-link]
=== `++ERC2981++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v5.0.0-rc.1/contracts/token/common/ERC2981.sol[{github-icon},role=heading-link]
[.hljs-theme-light.nopadding]
```solidity