Merge pull request #12871 from raxhvl/feat/erc-4626-interface

✨ feat: Improve documentation for ERC-4626 interface

Author: corwintines

public/content/developers/docs/standards/tokens/erc-4626/index.md

@@ -27,7 +27,7 @@ To better understand this page, we recommend you first read about [token standar
 #### asset {#asset}
 
 ```solidity
-function asset() public view returns (address)
+function asset() public view returns (address assetTokenAddress)
 ```
 
 This function returns the address of the underlying token used for the vault for accounting, depositing, withdrawing.
@@ -59,15 +59,15 @@ This function returns the amount of `assets` that would be exchanged by the vaul
 #### maxDeposit {#maxdeposit}
 
 ```solidity
-function maxDeposit(address receiver) public view returns (uint256)
+function maxDeposit(address receiver) public view returns (uint256 maxAssets)
 ```
 
 This function returns the maximum amount of underlying assets that can be deposited in a single [`deposit`](#deposit) call by the `receiver`.
 
 #### previewDeposit {#previewdeposit}
 
 ```solidity
-function previewDeposit(uint256 assets) public view returns (uint256)
+function previewDeposit(uint256 assets) public view returns (uint256 shares)
 ```
 
 This function allows users to simulate the effects of their deposit at the current block.
@@ -83,15 +83,15 @@ This function deposits `assets` of underlying tokens into the vault and grants o
 #### maxMint {#maxmint}
 
 ```solidity
-function maxMint(address receiver) public view returns (uint256)
+function maxMint(address receiver) public view returns (uint256 maxShares)
 ```
 
 This function returns the maximum amount of shares that can be minted in a single [`mint`](#mint) call by the `receiver`.
 
 #### previewMint {#previewmint}
 
 ```solidity
-function previewMint(uint256 shares) public view returns (uint256)
+function previewMint(uint256 shares) public view returns (uint256 assets)
 ```
 
 This function allows users to simulate the effects of their mint at the current block.
@@ -107,15 +107,15 @@ This function mints exactly `shares` vault shares to `receiver` by depositing `a
 #### maxWithdraw {#maxwithdraw}
 
 ```solidity
-function maxWithdraw(address owner) public view returns (uint256)
+function maxWithdraw(address owner) public view returns (uint256 maxAssets)
 ```
 
 This function returns the maximum amount of underlying assets that can be withdrawn from the `owner` balance with a single [`withdraw`](#withdraw) call.
 
 #### previewWithdraw {#previewwithdraw}
 
 ```solidity
-function previewWithdraw(uint256 assets) public view returns (uint256)
+function previewWithdraw(uint256 assets) public view returns (uint256 shares)
 ```
 
 This function allows users to simulate the effects of their withdrawal at the current block.
@@ -131,15 +131,15 @@ This function burns `shares` from `owner` and send exactly `assets` token from t
 #### maxRedeem {#maxredeem}
 
 ```solidity
-function maxRedeem(address owner) public view returns (uint256)
+function maxRedeem(address owner) public view returns (uint256 maxShares)
 ```
 
 This function returns the maximum amount of shares that can be redeemed from the `owner` balance through a [`redeem`](#redeem) call.
 
 #### previewRedeem {#previewredeem}
 
 ```solidity
-function previewRedeem(uint256 shares) public view returns (uint256)
+function previewRedeem(uint256 shares) public view returns (uint256 assets)
 ```
 
 This function allows users to simulate the effects of their redemption at the current block.
@@ -168,6 +168,10 @@ function balanceOf(address owner) public view returns (uint256)
 
 Returns the total amount of vault shares the `owner` currently has.
 
+### Map of the interface {#mapOfTheInterface}
+
+![Map of the ERC-4626 interface](./map-of-erc-4626.png)
+
 ### Events {#events}
 
 #### Deposit Event