Skip to content

Commit ecf05fb

Browse files
committed
Add additional dev notes to #getIssuanceAdjustments, #getRedemptionAdjustments docs
1 parent 2596d7b commit ecf05fb

File tree

1 file changed

+9
-1
lines changed

1 file changed

+9
-1
lines changed

contracts/protocol/modules/PerpV2LeverageModule.sol

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -579,7 +579,11 @@ contract PerpV2LeverageModule is ModuleBase, ReentrancyGuard, Ownable, IModuleIs
579579
/**
580580
* @dev Gets the positive equity collateral externalPositionUnit that would be calculated for
581581
* issuing a quantity of SetToken, representing the amount of collateral that would need to
582-
* be transferred in per SetToken.
582+
* be transferred in per SetToken. Values in the returned arrays map to the same index in the
583+
* SetToken's components array
584+
*
585+
* NOTE: This method will refactored to return the new unit rather the difference from the current
586+
* unit. (We will have to take into account scenario where position array is empty but there are deposits)
583587
*
584588
* @param _setToken Instance of SetToken
585589
* @param _setTokenQuantity Number of sets to issue
@@ -606,6 +610,10 @@ contract PerpV2LeverageModule is ModuleBase, ReentrancyGuard, Ownable, IModuleIs
606610
/**
607611
* @dev Gets the positive equity collateral externalPositionUnit that would be calculated for
608612
* redeeming a quantity of SetToken representing the amount of collateral returned per SetToken.
613+
* Values in the returned arrays map to the same index in the SetToken's components array.
614+
*
615+
* NOTE: This method will refactored to return the new unit rather the difference from the current
616+
* unit. (We will have to take into account scenario where position array is empty but there are deposits)
609617
*
610618
* @param _setToken Instance of SetToken
611619
* @param _setTokenQuantity Number of sets to issue

0 commit comments

Comments
 (0)