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-06-07 01:40:57 +00:00
parent 87456e3358
commit a72bca7fae
19 changed files with 152 additions and 153 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@ -564,7 +564,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/v4.9.0/contracts/token/ERC20/IERC20.sol[{github-icon},role=heading-link]
=== `++IERC20++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v4.9.1/contracts/token/ERC20/IERC20.sol[{github-icon},role=heading-link]
[.hljs-theme-light.nopadding]
```solidity
@ -676,7 +676,7 @@ a call to {approve}. `value` is the new allowance.
[.contract]
[[IERC20Metadata]]
=== `++IERC20Metadata++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v4.9.0/contracts/token/ERC20/extensions/IERC20Metadata.sol[{github-icon},role=heading-link]
=== `++IERC20Metadata++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v4.9.1/contracts/token/ERC20/extensions/IERC20Metadata.sol[{github-icon},role=heading-link]
[.hljs-theme-light.nopadding]
```solidity
@ -756,7 +756,7 @@ Returns the decimals places of the token.
[.contract]
[[ERC20]]
=== `++ERC20++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v4.9.0/contracts/token/ERC20/ERC20.sol[{github-icon},role=heading-link]
=== `++ERC20++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v4.9.1/contracts/token/ERC20/ERC20.sol[{github-icon},role=heading-link]
[.hljs-theme-light.nopadding]
```solidity
@ -1078,7 +1078,7 @@ To learn more about hooks, head to xref:ROOT:extending-contracts.adoc#using-hook
[.contract]
[[ERC20Burnable]]
=== `++ERC20Burnable++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v4.9.0/contracts/token/ERC20/extensions/ERC20Burnable.sol[{github-icon},role=heading-link]
=== `++ERC20Burnable++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v4.9.1/contracts/token/ERC20/extensions/ERC20Burnable.sol[{github-icon},role=heading-link]
[.hljs-theme-light.nopadding]
```solidity
@ -1169,7 +1169,7 @@ Requirements:
[.contract]
[[ERC20Capped]]
=== `++ERC20Capped++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v4.9.0/contracts/token/ERC20/extensions/ERC20Capped.sol[{github-icon},role=heading-link]
=== `++ERC20Capped++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v4.9.1/contracts/token/ERC20/extensions/ERC20Capped.sol[{github-icon},role=heading-link]
[.hljs-theme-light.nopadding]
```solidity
@ -1253,7 +1253,7 @@ See {ERC20-_mint}.
[.contract]
[[ERC20Pausable]]
=== `++ERC20Pausable++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v4.9.0/contracts/token/ERC20/extensions/ERC20Pausable.sol[{github-icon},role=heading-link]
=== `++ERC20Pausable++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v4.9.1/contracts/token/ERC20/extensions/ERC20Pausable.sol[{github-icon},role=heading-link]
[.hljs-theme-light.nopadding]
```solidity
@ -1353,7 +1353,7 @@ Requirements:
[.contract]
[[ERC20Permit]]
=== `++ERC20Permit++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v4.9.0/contracts/token/ERC20/extensions/ERC20Permit.sol[{github-icon},role=heading-link]
=== `++ERC20Permit++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v4.9.1/contracts/token/ERC20/extensions/ERC20Permit.sol[{github-icon},role=heading-link]
[.hljs-theme-light.nopadding]
```solidity
@ -1490,7 +1490,7 @@ _Available since v4.1._
[.contract]
[[ERC20Snapshot]]
=== `++ERC20Snapshot++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v4.9.0/contracts/token/ERC20/extensions/ERC20Snapshot.sol[{github-icon},role=heading-link]
=== `++ERC20Snapshot++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v4.9.1/contracts/token/ERC20/extensions/ERC20Snapshot.sol[{github-icon},role=heading-link]
[.hljs-theme-light.nopadding]
```solidity
@ -1666,7 +1666,7 @@ Emitted by {_snapshot} when a snapshot identified by `id` is created.
[.contract]
[[ERC20Votes]]
=== `++ERC20Votes++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v4.9.0/contracts/token/ERC20/extensions/ERC20Votes.sol[{github-icon},role=heading-link]
=== `++ERC20Votes++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v4.9.1/contracts/token/ERC20/extensions/ERC20Votes.sol[{github-icon},role=heading-link]
[.hljs-theme-light.nopadding]
```solidity
@ -1910,7 +1910,7 @@ Emits events {IVotes-DelegateChanged} and {IVotes-DelegateVotesChanged}.
[.contract]
[[ERC20VotesComp]]
=== `++ERC20VotesComp++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v4.9.0/contracts/token/ERC20/extensions/ERC20VotesComp.sol[{github-icon},role=heading-link]
=== `++ERC20VotesComp++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v4.9.1/contracts/token/ERC20/extensions/ERC20VotesComp.sol[{github-icon},role=heading-link]
[.hljs-theme-light.nopadding]
```solidity
@ -2082,7 +2082,7 @@ Maximum token supply. Reduced to `type(uint96).max` (2^96^ - 1) to fit COMP inte
[.contract]
[[ERC20Wrapper]]
=== `++ERC20Wrapper++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v4.9.0/contracts/token/ERC20/extensions/ERC20Wrapper.sol[{github-icon},role=heading-link]
=== `++ERC20Wrapper++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v4.9.1/contracts/token/ERC20/extensions/ERC20Wrapper.sol[{github-icon},role=heading-link]
[.hljs-theme-light.nopadding]
```solidity
@ -2195,7 +2195,7 @@ function that can be exposed with access control if desired.
[.contract]
[[ERC20FlashMint]]
=== `++ERC20FlashMint++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v4.9.0/contracts/token/ERC20/extensions/ERC20FlashMint.sol[{github-icon},role=heading-link]
=== `++ERC20FlashMint++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v4.9.1/contracts/token/ERC20/extensions/ERC20FlashMint.sol[{github-icon},role=heading-link]
[.hljs-theme-light.nopadding]
```solidity
@ -2337,7 +2337,7 @@ they can be burned.
[.contract]
[[ERC4626]]
=== `++ERC4626++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v4.9.0/contracts/token/ERC20/extensions/ERC4626.sol[{github-icon},role=heading-link]
=== `++ERC4626++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v4.9.1/contracts/token/ERC20/extensions/ERC4626.sol[{github-icon},role=heading-link]
[.hljs-theme-light.nopadding]
```solidity
@ -2619,7 +2619,7 @@ These contracts are preconfigured combinations of the above features. They can b
[.contract]
[[ERC20PresetMinterPauser]]
=== `++ERC20PresetMinterPauser++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v4.9.0/contracts/token/ERC20/presets/ERC20PresetMinterPauser.sol[{github-icon},role=heading-link]
=== `++ERC20PresetMinterPauser++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v4.9.1/contracts/token/ERC20/presets/ERC20PresetMinterPauser.sol[{github-icon},role=heading-link]
[.hljs-theme-light.nopadding]
```solidity
@ -2828,7 +2828,7 @@ Requirements:
[.contract]
[[ERC20PresetFixedSupply]]
=== `++ERC20PresetFixedSupply++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v4.9.0/contracts/token/ERC20/presets/ERC20PresetFixedSupply.sol[{github-icon},role=heading-link]
=== `++ERC20PresetFixedSupply++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v4.9.1/contracts/token/ERC20/presets/ERC20PresetFixedSupply.sol[{github-icon},role=heading-link]
[.hljs-theme-light.nopadding]
```solidity
@ -2927,7 +2927,7 @@ See {ERC20-constructor}.
[.contract]
[[SafeERC20]]
=== `++SafeERC20++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v4.9.0/contracts/token/ERC20/utils/SafeERC20.sol[{github-icon},role=heading-link]
=== `++SafeERC20++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v4.9.1/contracts/token/ERC20/utils/SafeERC20.sol[{github-icon},role=heading-link]
[.hljs-theme-light.nopadding]
```solidity
@ -3015,7 +3015,7 @@ Revert on invalid signature.
[.contract]
[[TokenTimelock]]
=== `++TokenTimelock++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v4.9.0/contracts/token/ERC20/utils/TokenTimelock.sol[{github-icon},role=heading-link]
=== `++TokenTimelock++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v4.9.1/contracts/token/ERC20/utils/TokenTimelock.sol[{github-icon},role=heading-link]
[.hljs-theme-light.nopadding]
```solidity