Skip to content

Commit fc6f7a5

Browse files
committed
minor change to documentation comments
1 parent 59783af commit fc6f7a5

File tree

1 file changed

+0
-8
lines changed

1 file changed

+0
-8
lines changed

src/Solaxy.sol

-8
Original file line numberDiff line numberDiff line change
@@ -120,8 +120,6 @@ contract Solaxy is Token, IERC4626, ReentrancyGuard {
120120
/**
121121
* @notice Computes the number of shares to be minted for a given amount of assets to be deposited.
122122
* @dev Utilizes the equation y = sqrt((0.0000125x^2 + A) / 0.0000125) - x, derived from the trapezium area formula.
123-
* @param assets The amount of assets to be deposited.
124-
* @return shares The calculated number of shares minted for the deposited assets.
125123
*/
126124
function previewDeposit(uint256 assets) public view returns (uint256 shares) {
127125
UD60x18 totalShares = ud(totalSupply());
@@ -131,8 +129,6 @@ contract Solaxy is Token, IERC4626, ReentrancyGuard {
131129
/**
132130
* @notice Computes the number of shares to be burned for a given amount of assets to be withdrawn.
133131
* @dev Utilizes the equation y = x - sqrt((0.0000125x^2 - A) / 0.0000125), derived from the trapezium area formula.
134-
* @param assets The amount of assets to be withdrawn.
135-
* @return shares The calculated number of shares to be burned in the withdrawal.
136132
*/
137133
function previewWithdraw(uint256 assets) public view returns (uint256 shares) {
138134
UD60x18 totalShares = ud(totalSupply());
@@ -144,8 +140,6 @@ contract Solaxy is Token, IERC4626, ReentrancyGuard {
144140
* @dev Computes assets as the area under a linear curve with a simplified form of the area of a trapezium,
145141
* f(x) = mx + c, and Area = 1/2 * (a + b) * h;
146142
* During mint calculates area as SemiSlope * (finalSupply^2 - initialSupply^2), where SemiSlope = (0.000025 / 2)
147-
* @param shares The number of shares to be minted.
148-
* @return assets The computed assets.
149143
*/
150144
function previewMint(uint256 shares) public view returns (uint256 assets) {
151145
UD60x18 totalShares = ud(totalSupply());
@@ -157,8 +151,6 @@ contract Solaxy is Token, IERC4626, ReentrancyGuard {
157151
* @dev Computes assets as the area under a linear curve with a simplified form of the area of a trapezium,
158152
* f(x) = mx + c, and Area = 1/2 * (a + b) * h;
159153
* During redeem, calculates area as SemiSlope * (initialSupply^2 - finalSupply^2), where SemiSlope = (0.000025 / 2)
160-
* @param shares The number of shares to be redeemed.
161-
* @return assets The computed assets.
162154
*/
163155
function previewRedeem(uint256 shares) public view returns (uint256 assets) {
164156
UD60x18 totalShares = ud(totalSupply());

0 commit comments

Comments
 (0)