NoBey/openzeppelin-contracts
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Improve ERC20FlashMint documentation (#3719)

Browse Source 
Co-authored-by: Hadrien Croubois <hadrien.croubois@gmail.com>
This commit is contained in:
tincho
2022-09-23 11:48:39 +02:00
committed by GitHub
parent 8f0d4d4a41
commit aa4b901788
1 changed files with 6 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
contracts/token/ERC20/extensions/ERC20FlashMint.sol
View File

@ -29,9 +29,9 @@ abstract contract ERC20FlashMint is ERC20, IERC3156FlashLender {
} }
/** /**
* @dev Returns the fee applied when doing flash loans. By default this * @dev Returns the fee applied when doing flash loans. This function calls
* implementation has 0 fees. This function can be overloaded to make * the {_flashFee} function which returns the fee applied when doing flash
* the flash loan mechanism deflationary. * loans.
* @param token The token to be flash loaned. * @param token The token to be flash loaned.
* @param amount The amount of tokens to be loaned. * @param amount The amount of tokens to be loaned.
* @return The fees applied to the corresponding flash loan. * @return The fees applied to the corresponding flash loan.
@ -42,7 +42,9 @@ abstract contract ERC20FlashMint is ERC20, IERC3156FlashLender {
} }
/** /**
* @dev Returns the fee applied when doing flash loans. This function calls the {flashFee} function which returns the fee applied when doing flash loans. * @dev Returns the fee applied when doing flash loans. By default this
* implementation has 0 fees. This function can be overloaded to make
* the flash loan mechanism deflationary.
* @param token The token to be flash loaned. * @param token The token to be flash loaned.
* @param amount The amount of tokens to be loaned. * @param amount The amount of tokens to be loaned.
* @return The fees applied to the corresponding flash loan. * @return The fees applied to the corresponding flash loan.