Skip to content
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

Merged
merged 11 commits into from
Jul 6, 2023
Merged

Docs - some interfaces #1702

merged 11 commits into from
Jul 6, 2023

Conversation

leomassazza
Copy link
Contributor

No description provided.

@codecov
Copy link

codecov bot commented Jul 3, 2023

Codecov Report

Merging #1702 (5e404b2) into main (2049ad3) will not change coverage.
The diff coverage is n/a.

@@           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           
Flag Coverage Δ
core-contracts 93.26% <ø> (ø)
core-modules 90.47% <ø> (ø)
core-utils 68.57% <ø> (ø)

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

@leomassazza leomassazza self-assigned this Jul 3, 2023
* @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);
Copy link
Contributor

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

Copy link
Contributor

@0xjocke 0xjocke left a 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

@0xjocke
Copy link
Contributor

0xjocke commented Jul 5, 2023

Merge in my changes and fixed conflicts :)

@leomassazza leomassazza merged commit 1762828 into main Jul 6, 2023
19 checks passed
@leomassazza leomassazza deleted the docs-market-and-account-interfaces branch July 6, 2023 16:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants