-
Notifications
You must be signed in to change notification settings - Fork 58
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Docs - some interfaces #1702
Docs - some interfaces #1702
Conversation
Codecov Report
@@ Coverage Diff @@
## main #1702 +/- ##
=======================================
Coverage 72.77% 72.77%
=======================================
Files 57 57
Lines 720 720
Branches 236 236
=======================================
Hits 524 524
Misses 167 167
Partials 29 29
📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more |
* @notice Gets the max market value of a market. | ||
* @param marketId id of the market. | ||
* @return maxMarketValue the max market value. | ||
*/ | ||
function getMaxMarketValue(uint128 marketId) external view returns (uint256 maxMarketValue); |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Maybe mention:
Max Market Value controls the maximum open interest a market an have on either side (Long | Short). So the total Open Interest for a market is Max Market Value * 2. This value is not defined in USD but in the native asset
markets/perps-market/contracts/interfaces/IAsyncOrderModule.sol
Outdated
Show resolved
Hide resolved
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
One suggestion to be a bit more elaborate on maxMarketValue. Not sure if we want to avoid that but I just know that it's common to get question about it
Merge in my changes and fixed conflicts :) |
No description provided.