Skip to content

Commit 35132a8

Browse files
committed
doc: add some explanation on scale
1 parent 378f35f commit 35132a8

File tree

1 file changed

+2
-0
lines changed

1 file changed

+2
-0
lines changed

contracts/helpers/GenericHarvester.sol

+2
Original file line numberDiff line numberDiff line change
@@ -257,6 +257,8 @@ contract GenericHarvester is BaseHarvester, IERC3156FlashBorrower, RouterSwapper
257257
/// some yieldBearingAsset that can then be used for people looking to burn stablecoins
258258
/// @dev Due to potential transaction fees within the Transmuter, this function doesn't exactly bring
259259
/// `yieldBearingAsset` to the target exposure
260+
/// @dev scale is a number between 0 and 1e9 that represents the proportion of the
261+
/// it is used to lower the amount of the asset to harvest for exemple to have a lower slippage
260262
function harvest(address yieldBearingAsset, uint256 scale, bytes calldata extraData) public virtual {
261263
if (scale > 1e9) revert InvalidParam();
262264
YieldBearingParams memory yieldBearingInfo = yieldBearingData[yieldBearingAsset];

0 commit comments

Comments
 (0)