@@ -35,67 +35,67 @@ abstract contract ERC4626 is ERC20, IERC4626 {
35
35
_asset = asset_;
36
36
}
37
37
38
- /** @dev See {IERC4262-asset} */
38
+ /** @dev See {IERC4262-asset}. */
39
39
function asset () public view virtual override returns (address ) {
40
40
return address (_asset);
41
41
}
42
42
43
- /** @dev See {IERC4262-totalAssets} */
43
+ /** @dev See {IERC4262-totalAssets}. */
44
44
function totalAssets () public view virtual override returns (uint256 ) {
45
45
return _asset.balanceOf (address (this ));
46
46
}
47
47
48
- /** @dev See {IERC4262-convertToShares} */
48
+ /** @dev See {IERC4262-convertToShares}. */
49
49
function convertToShares (uint256 assets ) public view virtual override returns (uint256 shares ) {
50
50
return _convertToShares (assets, Math.Rounding.Down);
51
51
}
52
52
53
- /** @dev See {IERC4262-convertToAssets} */
53
+ /** @dev See {IERC4262-convertToAssets}. */
54
54
function convertToAssets (uint256 shares ) public view virtual override returns (uint256 assets ) {
55
55
return _convertToAssets (shares, Math.Rounding.Down);
56
56
}
57
57
58
- /** @dev See {IERC4262-maxDeposit} */
58
+ /** @dev See {IERC4262-maxDeposit}. */
59
59
function maxDeposit (address ) public view virtual override returns (uint256 ) {
60
60
return _isVaultCollateralized () ? type (uint256 ).max : 0 ;
61
61
}
62
62
63
- /** @dev See {IERC4262-maxMint} */
63
+ /** @dev See {IERC4262-maxMint}. */
64
64
function maxMint (address ) public view virtual override returns (uint256 ) {
65
65
return type (uint256 ).max;
66
66
}
67
67
68
- /** @dev See {IERC4262-maxWithdraw} */
68
+ /** @dev See {IERC4262-maxWithdraw}. */
69
69
function maxWithdraw (address owner ) public view virtual override returns (uint256 ) {
70
70
return _convertToAssets (balanceOf (owner), Math.Rounding.Down);
71
71
}
72
72
73
- /** @dev See {IERC4262-maxRedeem} */
73
+ /** @dev See {IERC4262-maxRedeem}. */
74
74
function maxRedeem (address owner ) public view virtual override returns (uint256 ) {
75
75
return balanceOf (owner);
76
76
}
77
77
78
- /** @dev See {IERC4262-previewDeposit} */
78
+ /** @dev See {IERC4262-previewDeposit}. */
79
79
function previewDeposit (uint256 assets ) public view virtual override returns (uint256 ) {
80
80
return _convertToShares (assets, Math.Rounding.Down);
81
81
}
82
82
83
- /** @dev See {IERC4262-previewMint} */
83
+ /** @dev See {IERC4262-previewMint}. */
84
84
function previewMint (uint256 shares ) public view virtual override returns (uint256 ) {
85
85
return _convertToAssets (shares, Math.Rounding.Up);
86
86
}
87
87
88
- /** @dev See {IERC4262-previewWithdraw} */
88
+ /** @dev See {IERC4262-previewWithdraw}. */
89
89
function previewWithdraw (uint256 assets ) public view virtual override returns (uint256 ) {
90
90
return _convertToShares (assets, Math.Rounding.Up);
91
91
}
92
92
93
- /** @dev See {IERC4262-previewRedeem} */
93
+ /** @dev See {IERC4262-previewRedeem}. */
94
94
function previewRedeem (uint256 shares ) public view virtual override returns (uint256 ) {
95
95
return _convertToAssets (shares, Math.Rounding.Down);
96
96
}
97
97
98
- /** @dev See {IERC4262-deposit} */
98
+ /** @dev See {IERC4262-deposit}. */
99
99
function deposit (uint256 assets , address receiver ) public virtual override returns (uint256 ) {
100
100
require (assets <= maxDeposit (receiver), "ERC4626: deposit more than max " );
101
101
@@ -105,7 +105,7 @@ abstract contract ERC4626 is ERC20, IERC4626 {
105
105
return shares;
106
106
}
107
107
108
- /** @dev See {IERC4262-mint} */
108
+ /** @dev See {IERC4262-mint}. */
109
109
function mint (uint256 shares , address receiver ) public virtual override returns (uint256 ) {
110
110
require (shares <= maxMint (receiver), "ERC4626: mint more than max " );
111
111
@@ -115,7 +115,7 @@ abstract contract ERC4626 is ERC20, IERC4626 {
115
115
return assets;
116
116
}
117
117
118
- /** @dev See {IERC4262-withdraw} */
118
+ /** @dev See {IERC4262-withdraw}. */
119
119
function withdraw (
120
120
uint256 assets ,
121
121
address receiver ,
@@ -129,7 +129,7 @@ abstract contract ERC4626 is ERC20, IERC4626 {
129
129
return shares;
130
130
}
131
131
132
- /** @dev See {IERC4262-redeem} */
132
+ /** @dev See {IERC4262-redeem}. */
133
133
function redeem (
134
134
uint256 shares ,
135
135
address receiver ,
@@ -144,7 +144,7 @@ abstract contract ERC4626 is ERC20, IERC4626 {
144
144
}
145
145
146
146
/**
147
- * @dev Internal convertion function (from assets to shares) with support for rounding direction
147
+ * @dev Internal conversion function (from assets to shares) with support for rounding direction.
148
148
*
149
149
* Will revert if assets > 0, totalSupply > 0 and totalAssets = 0. That corresponds to a case where any asset
150
150
* would represent an infinite amout of shares.
@@ -158,7 +158,7 @@ abstract contract ERC4626 is ERC20, IERC4626 {
158
158
}
159
159
160
160
/**
161
- * @dev Internal convertion function (from shares to assets) with support for rounding direction
161
+ * @dev Internal conversion function (from shares to assets) with support for rounding direction.
162
162
*/
163
163
function _convertToAssets (uint256 shares , Math.Rounding rounding ) internal view virtual returns (uint256 assets ) {
164
164
uint256 supply = totalSupply ();
@@ -169,7 +169,7 @@ abstract contract ERC4626 is ERC20, IERC4626 {
169
169
}
170
170
171
171
/**
172
- * @dev Deposit/mint common workflow
172
+ * @dev Deposit/mint common workflow.
173
173
*/
174
174
function _deposit (
175
175
address caller ,
@@ -191,7 +191,7 @@ abstract contract ERC4626 is ERC20, IERC4626 {
191
191
}
192
192
193
193
/**
194
- * @dev Withdraw/redeem common workflow
194
+ * @dev Withdraw/redeem common workflow.
195
195
*/
196
196
function _withdraw (
197
197
address caller ,
@@ -204,7 +204,7 @@ abstract contract ERC4626 is ERC20, IERC4626 {
204
204
_spendAllowance (owner, caller, shares);
205
205
}
206
206
207
- // If _asset is ERC777, `transfer` can trigger trigger a reentrancy AFTER the transfer happens through the
207
+ // If _asset is ERC777, `transfer` can trigger a reentrancy AFTER the transfer happens through the
208
208
// `tokensReceived` hook. On the other hand, the `tokensToSend` hook, that is triggered before the transfer,
209
209
// calls the vault, which is assumed not malicious.
210
210
//
0 commit comments