adds @param note to trancheAndDeposit feePaid to clarify input of 0 w…

…hen fee token is perp (#92)
ampleforth · Aug 29, 2022 · 83735e6 · 83735e6
1 parent 4d420b6
commit 83735e6
Showing 1 changed file with 1 addition and 1 deletion.
diff --git a/spot-contracts/contracts/RouterV1.sol b/spot-contracts/contracts/RouterV1.sol
@@ -93,7 +93,7 @@ contract RouterV1 {
     /// @param perp Address of the perp contract.
     /// @param bond Address of the deposit bond.
     /// @param collateralAmount The amount of collateral the user wants to tranche.
-    /// @param feePaid The fee paid to the perp contract to mint perp.
+    /// @param feePaid The fee paid to the perp contract to mint perp when the fee token is not the perp token itself, otherwise 0.
     /// @dev Fee to be paid should be pre-computed off-chain using the preview function.
     function trancheAndDeposit(
         IPerpetualTranche perp,