Skip to content

Commit 4353ac1

Browse files
author
Sachin
authored
chore(IPerpV2BasisTradingModule): Add getUpdatedSettledFunding #245
1 parent 8e0e8d3 commit 4353ac1

File tree

2 files changed

+14
-1
lines changed

2 files changed

+14
-1
lines changed

contracts/interfaces/IPerpV2BasisTradingModule.sol

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -156,4 +156,17 @@ interface IPerpV2BasisTradingModule is IPerpV2LeverageModuleV2 {
156156
*/
157157
function updateFeeRecipient(ISetToken _setToken, address _newFeeRecipient)
158158
external;
159+
160+
/**
161+
* @dev Adds pending funding payment to tracked settled funding. Returns updated settled funding value in precise units (10e18).
162+
*
163+
* NOTE: Tracked settled funding value can not be less than zero, hence it is reset to zero if pending funding
164+
* payment is negative and |pending funding payment| >= |settledFunding[_setToken]|.
165+
*
166+
* NOTE: Returned updated settled funding value is correct only for the current block since pending funding payment
167+
* updates every block.
168+
*
169+
* @param _setToken Instance of SetToken
170+
*/
171+
function getUpdatedSettledFunding(ISetToken _setToken) external view returns (uint256);
159172
}

contracts/protocol/modules/v2/PerpV2BasisTradingModule.sol

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -440,7 +440,7 @@ contract PerpV2BasisTradingModule is PerpV2LeverageModuleV2 {
440440
}
441441

442442
/**
443-
* @dev Adds pending funding payment to tracked settled funding. Returns updated settled funding value.
443+
* @dev Adds pending funding payment to tracked settled funding. Returns updated settled funding value in precise units (10e18).
444444
*
445445
* NOTE: Tracked settled funding value can not be less than zero, hence it is reset to zero if pending funding
446446
* payment is negative and |pending funding payment| >= |settledFunding[_setToken]|.

0 commit comments

Comments
 (0)