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
2022-11-25 16:12:49 +00:00
parent 6db3408885
commit 8d69b7affd
6 changed files with 44 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@ -2167,8 +2167,12 @@ underlying "assets" through standardized {deposit}, {mint}, {redeem} and {burn}
the ERC20 standard. Any additional extensions included along it would affect the "shares" token represented by this
contract and not the "assets" token which is an independent contract.
CAUTION: Deposits and withdrawals may incur unexpected slippage. Users should verify that the amount received of
shares or assets is as expected. EOAs should operate through a wrapper that performs these checks such as
CAUTION: When the vault is empty or nearly empty, deposits are at high risk of being stolen through frontrunning with
a "donation" to the vault that inflates the price of a share. This is variously known as a donation or inflation
attack and is essentially a problem of slippage. Vault deployers can protect against this attack by making an initial
deposit of a non-trivial amount of the asset, such that price manipulation becomes infeasible. Withdrawals may
similarly be affected by slippage. Users can protect against this attack as well unexpected slippage in general by
verifying the amount received is as expected, using a wrapper that performs these checks such as
https://github.com/fei-protocol/ERC4626#erc4626router-and-base[ERC4626Router].
_Available since v4.7._
@ -2353,6 +2357,9 @@ See {IERC4626-deposit}.
See {IERC4626-mint}.
As opposed to {deposit}, minting is allowed even if the vault is in a state where the price of a share is zero.
In this case, the shares will be minted without requiring any assets to be deposited.
[.contract-item]
[[ERC4626-withdraw-uint256-address-address-]]
==== `[.contract-item-name]#++withdraw++#++(uint256 assets, address receiver, address owner) → uint256++` [.item-kind]#public#

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

@ -4157,7 +4157,8 @@ _Available since v4.5._
==== `[.contract-item-name]#++getAtBlock++#++(struct Checkpoints.History self, uint256 blockNumber) → uint256++` [.item-kind]#internal#
Returns the value at a given block number. If a checkpoint is not available at that block, the closest one
before it is returned, or zero otherwise.
before it is returned, or zero otherwise. Because the number returned corresponds to that at the end of the
block, the requested block number must be in the past, excluding the current block.
[.contract-item]
[[Checkpoints-getAtProbablyRecentBlock-struct-Checkpoints-History-uint256-]]