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

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