FuturesMarketData¶
Description¶
Source: contracts/FuturesMarketData.sol
Structs¶
FeeRates¶
| Field | Type | Description |
|---|---|---|
takerFee |
uint256 |
TBA |
makerFee |
uint256 |
TBA |
takerFeeNextPrice |
uint256 |
TBA |
makerFeeNextPrice |
uint256 |
TBA |
FundingDetails¶
| Field | Type | Description |
|---|---|---|
currentFundingRate |
int256 |
TBA |
unrecordedFunding |
int256 |
TBA |
fundingLastRecomputed |
uint256 |
TBA |
FundingParameters¶
| Field | Type | Description |
|---|---|---|
maxFundingRate |
uint256 |
TBA |
skewScaleUSD |
uint256 |
TBA |
FuturesGlobals¶
| Field | Type | Description |
|---|---|---|
minInitialMargin |
uint256 |
TBA |
liquidationFeeRatio |
uint256 |
TBA |
liquidationBufferRatio |
uint256 |
TBA |
minKeeperFee |
uint256 |
TBA |
MarketData¶
| Field | Type | Description |
|---|---|---|
market |
address |
TBA |
baseAsset |
bytes32 |
TBA |
marketKey |
bytes32 |
TBA |
feeRates |
struct FuturesMarketData.FeeRates |
TBA |
limits |
struct FuturesMarketData.MarketLimits |
TBA |
fundingParameters |
struct FuturesMarketData.FundingParameters |
TBA |
marketSizeDetails |
struct FuturesMarketData.MarketSizeDetails |
TBA |
priceDetails |
struct FuturesMarketData.PriceDetails |
TBA |
MarketLimits¶
| Field | Type | Description |
|---|---|---|
maxLeverage |
uint256 |
TBA |
maxMarketValueUSD |
uint256 |
TBA |
MarketSizeDetails¶
| Field | Type | Description |
|---|---|---|
marketSize |
uint256 |
TBA |
sides |
struct FuturesMarketData.Sides |
TBA |
marketDebt |
uint256 |
TBA |
marketSkew |
int256 |
TBA |
MarketSummary¶
| Field | Type | Description |
|---|---|---|
market |
address |
TBA |
asset |
bytes32 |
TBA |
key |
bytes32 |
TBA |
maxLeverage |
uint256 |
TBA |
price |
uint256 |
TBA |
marketSize |
uint256 |
TBA |
marketSkew |
int256 |
TBA |
marketDebt |
uint256 |
TBA |
currentFundingRate |
int256 |
TBA |
feeRates |
struct FuturesMarketData.FeeRates |
TBA |
PositionData¶
| Field | Type | Description |
|---|---|---|
position |
struct IFuturesMarketBaseTypes.Position |
TBA |
notionalValue |
int256 |
TBA |
profitLoss |
int256 |
TBA |
accruedFunding |
int256 |
TBA |
remainingMargin |
uint256 |
TBA |
accessibleMargin |
uint256 |
TBA |
liquidationPrice |
uint256 |
TBA |
canLiquidatePosition |
bool |
TBA |
PriceDetails¶
| Field | Type | Description |
|---|---|---|
price |
uint256 |
TBA |
invalid |
bool |
TBA |
Sides¶
| Field | Type | Description |
|---|---|---|
long |
uint256 |
TBA |
short |
uint256 |
TBA |
Variables¶
resolverProxy¶
Type: contract IAddressResolver
Constructor¶
constructor¶
Details
Signature
constructor(contract IAddressResolver _resolverProxy)
Visibility
public
State Mutability
``
Views¶
allMarketSummaries¶
Details
Signature
allMarketSummaries() view returns (struct FuturesMarketData.MarketSummary[])
Visibility
external
State Mutability
view
globals¶
Details
Signature
globals() view returns (struct FuturesMarketData.FuturesGlobals)
Visibility
external
State Mutability
view
marketDetails¶
Details
Signature
marketDetails(contract IFuturesMarket market) view returns (struct FuturesMarketData.MarketData)
Visibility
external
State Mutability
view
marketDetailsForKey¶
Details
Signature
marketDetailsForKey(bytes32 marketKey) view returns (struct FuturesMarketData.MarketData)
Visibility
external
State Mutability
view
marketSummaries¶
Details
Signature
marketSummaries(address[] markets) view returns (struct FuturesMarketData.MarketSummary[])
Visibility
external
State Mutability
view
marketSummariesForKeys¶
Details
Signature
marketSummariesForKeys(bytes32[] marketKeys) view returns (struct FuturesMarketData.MarketSummary[])
Visibility
external
State Mutability
view
parameters¶
Details
Signature
parameters(bytes32 marketKey) view returns (struct IFuturesMarketSettings.Parameters)
Visibility
external
State Mutability
view
positionDetails¶
Details
Signature
positionDetails(contract IFuturesMarket market, address account) view returns (struct FuturesMarketData.PositionData)
Visibility
external
State Mutability
view
positionDetailsForMarketKey¶
Details
Signature
positionDetailsForMarketKey(bytes32 marketKey, address account) view returns (struct FuturesMarketData.PositionData)
Visibility
external
State Mutability
view
Internal Functions¶
_accessibleMargin¶
Details
Signature
_accessibleMargin(contract IFuturesMarket market, address account) view returns (uint256)
Visibility
internal
State Mutability
view
_accruedFunding¶
Details
Signature
_accruedFunding(contract IFuturesMarket market, address account) view returns (int256)
Visibility
internal
State Mutability
view
_fundingParameters¶
Details
Signature
_fundingParameters(struct IFuturesMarketSettings.Parameters params) pure returns (struct FuturesMarketData.FundingParameters)
Visibility
internal
State Mutability
pure
_futuresMarketManager¶
Details
Signature
_futuresMarketManager() view returns (contract IFuturesMarketManager)
Visibility
internal
State Mutability
view
_futuresMarketSettings¶
Details
Signature
_futuresMarketSettings() view returns (contract IFuturesMarketSettings)
Visibility
internal
State Mutability
view
_liquidationPrice¶
Details
Signature
_liquidationPrice(contract IFuturesMarket market, address account) view returns (uint256)
Visibility
internal
State Mutability
view
_marketDetails¶
Details
Signature
_marketDetails(contract IFuturesMarket market) view returns (struct FuturesMarketData.MarketData)
Visibility
internal
State Mutability
view
_marketSizes¶
Details
Signature
_marketSizes(contract IFuturesMarket market) view returns (struct FuturesMarketData.Sides)
Visibility
internal
State Mutability
view
_marketSummaries¶
Details
Signature
_marketSummaries(address[] markets) view returns (struct FuturesMarketData.MarketSummary[])
Visibility
internal
State Mutability
view
_notionalValue¶
Details
Signature
_notionalValue(contract IFuturesMarket market, address account) view returns (int256)
Visibility
internal
State Mutability
view
_parameters¶
Details
Signature
_parameters(bytes32 marketKey) view returns (struct IFuturesMarketSettings.Parameters)
Visibility
internal
State Mutability
view
_position¶
Details
Signature
_position(contract IFuturesMarket market, address account) view returns (struct IFuturesMarketBaseTypes.Position)
Visibility
internal
State Mutability
view
_positionDetails¶
Details
Signature
_positionDetails(contract IFuturesMarket market, address account) view returns (struct FuturesMarketData.PositionData)
Visibility
internal
State Mutability
view
_profitLoss¶
Details
Signature
_profitLoss(contract IFuturesMarket market, address account) view returns (int256)
Visibility
internal
State Mutability
view
_remainingMargin¶
Details
Signature
_remainingMargin(contract IFuturesMarket market, address account) view returns (uint256)
Visibility
internal
State Mutability
view