IPerpsV2MarketConsolidated¶
Description¶
Source: contracts/interfaces/IPerpsV2MarketConsolidated.sol
Structs¶
DelayedOrder
¶
Field | Type | Description |
---|---|---|
isOffchain |
bool |
TBA |
sizeDelta |
int128 |
TBA |
desiredFillPrice |
uint128 |
TBA |
targetRoundId |
uint128 |
TBA |
commitDeposit |
uint128 |
TBA |
keeperDeposit |
uint128 |
TBA |
executableAtTime |
uint256 |
TBA |
intentionTime |
uint256 |
TBA |
trackingCode |
bytes32 |
TBA |
Position
¶
Field | Type | Description |
---|---|---|
id |
uint64 |
TBA |
lastFundingIndex |
uint64 |
TBA |
margin |
uint128 |
TBA |
lastPrice |
uint128 |
TBA |
size |
int128 |
TBA |
Views¶
accessibleMargin
¶
Details
Signature
accessibleMargin(address account) view returns (uint256 marginAccessible, bool invalid)
Visibility
external
State Mutability
view
accruedFunding
¶
Details
Signature
accruedFunding(address account) view returns (int256 funding, bool invalid)
Visibility
external
State Mutability
view
assetPrice
¶
Details
Signature
assetPrice() view returns (uint256 price, bool invalid)
Visibility
external
State Mutability
view
baseAsset
¶
Details
Signature
baseAsset() view returns (bytes32 key)
Visibility
external
State Mutability
view
canLiquidate
¶
Details
Signature
canLiquidate(address account) view returns (bool)
Visibility
external
State Mutability
view
currentFundingRate
¶
Details
Signature
currentFundingRate() view returns (int256 fundingRate)
Visibility
external
State Mutability
view
currentFundingVelocity
¶
Details
Signature
currentFundingVelocity() view returns (int256 fundingVelocity)
Visibility
external
State Mutability
view
delayedOrders
¶
Details
Signature
delayedOrders(address account) view returns (struct IPerpsV2MarketConsolidated.DelayedOrder)
Visibility
external
State Mutability
view
fillPrice
¶
Details
Signature
fillPrice(int256 sizeDelta) view returns (uint256 price, bool invalid)
Visibility
external
State Mutability
view
fundingLastRecomputed
¶
Details
Signature
fundingLastRecomputed() view returns (uint32 timestamp)
Visibility
external
State Mutability
view
fundingRateLastRecomputed
¶
Details
Signature
fundingRateLastRecomputed() view returns (int128 fundingRate)
Visibility
external
State Mutability
view
fundingSequence
¶
Details
Signature
fundingSequence(uint256 index) view returns (int128 netFunding)
Visibility
external
State Mutability
view
fundingSequenceLength
¶
Details
Signature
fundingSequenceLength() view returns (uint256 length)
Visibility
external
State Mutability
view
isFlagged
¶
Details
Signature
isFlagged(address account) view returns (bool)
Visibility
external
State Mutability
view
liquidationFee
¶
Details
Signature
liquidationFee(address account) view returns (uint256)
Visibility
external
State Mutability
view
liquidationPrice
¶
Details
Signature
liquidationPrice(address account) view returns (uint256 price, bool invalid)
Visibility
external
State Mutability
view
marketDebt
¶
Details
Signature
marketDebt() view returns (uint256 debt, bool isInvalid)
Visibility
external
State Mutability
view
marketKey
¶
Details
Signature
marketKey() view returns (bytes32 key)
Visibility
external
State Mutability
view
marketSize
¶
Details
Signature
marketSize() view returns (uint128 size)
Visibility
external
State Mutability
view
marketSizes
¶
Details
Signature
marketSizes() view returns (uint256 long, uint256 short)
Visibility
external
State Mutability
view
marketSkew
¶
Details
Signature
marketSkew() view returns (int128 skew)
Visibility
external
State Mutability
view
notionalValue
¶
Details
Signature
notionalValue(address account) view returns (int256 value, bool invalid)
Visibility
external
State Mutability
view
orderFee
¶
Details
Signature
orderFee(int256 sizeDelta, enum IPerpsV2MarketBaseTypes.OrderType orderType) view returns (uint256 fee, bool invalid)
Visibility
external
State Mutability
view
positions
¶
Details
Signature
positions(address account) view returns (struct IPerpsV2MarketConsolidated.Position)
Visibility
external
State Mutability
view
postTradeDetails
¶
Details
Signature
postTradeDetails(int256 sizeDelta, uint256 tradePrice, enum IPerpsV2MarketBaseTypes.OrderType orderType, address sender) view returns (uint256 margin, int256 size, uint256 price, uint256 liqPrice, uint256 fee, enum IPerpsV2MarketConsolidated.Status status)
Visibility
external
State Mutability
view
profitLoss
¶
Details
Signature
profitLoss(address account) view returns (int256 pnl, bool invalid)
Visibility
external
State Mutability
view
remainingMargin
¶
Details
Signature
remainingMargin(address account) view returns (uint256 marginRemaining, bool invalid)
Visibility
external
State Mutability
view
unrecordedFunding
¶
Details
Signature
unrecordedFunding() view returns (int256 funding, bool invalid)
Visibility
external
State Mutability
view
External Functions¶
cancelDelayedOrder
¶
Details
Signature
cancelDelayedOrder(address account)
Visibility
external
State Mutability
``
cancelOffchainDelayedOrder
¶
Details
Signature
cancelOffchainDelayedOrder(address account)
Visibility
external
State Mutability
``
closePosition
¶
Details
Signature
closePosition(uint256 desiredFillPrice)
Visibility
external
State Mutability
``
closePositionWithTracking
¶
Details
Signature
closePositionWithTracking(uint256 desiredFillPrice, bytes32 trackingCode)
Visibility
external
State Mutability
``
executeDelayedOrder
¶
Details
Signature
executeDelayedOrder(address account)
Visibility
external
State Mutability
``
executeOffchainDelayedOrder
¶
Details
Signature
executeOffchainDelayedOrder(address account, bytes[] priceUpdateData) payable
Visibility
external
State Mutability
payable
flagPosition
¶
Details
Signature
flagPosition(address account)
Visibility
external
State Mutability
``
forceLiquidatePosition
¶
Details
Signature
forceLiquidatePosition(address account)
Visibility
external
State Mutability
``
liquidatePosition
¶
Details
Signature
liquidatePosition(address account)
Visibility
external
State Mutability
``
modifyPosition
¶
Details
Signature
modifyPosition(int256 sizeDelta, uint256 desiredFillPrice)
Visibility
external
State Mutability
``
modifyPositionWithTracking
¶
Details
Signature
modifyPositionWithTracking(int256 sizeDelta, uint256 desiredFillPrice, bytes32 trackingCode)
Visibility
external
State Mutability
``
recomputeFunding
¶
Details
Signature
recomputeFunding() returns (uint256 lastIndex)
Visibility
external
State Mutability
``
submitCloseDelayedOrderWithTracking
¶
Details
Signature
submitCloseDelayedOrderWithTracking(uint256 desiredTimeDelta, uint256 desiredFillPrice, bytes32 trackingCode)
Visibility
external
State Mutability
``
submitCloseOffchainDelayedOrderWithTracking
¶
Details
Signature
submitCloseOffchainDelayedOrderWithTracking(uint256 desiredFillPrice, bytes32 trackingCode)
Visibility
external
State Mutability
``
submitDelayedOrder
¶
Details
Signature
submitDelayedOrder(int256 sizeDelta, uint256 desiredTimeDelta, uint256 desiredFillPrice)
Visibility
external
State Mutability
``
submitDelayedOrderWithTracking
¶
Details
Signature
submitDelayedOrderWithTracking(int256 sizeDelta, uint256 desiredTimeDelta, uint256 desiredFillPrice, bytes32 trackingCode)
Visibility
external
State Mutability
``
submitOffchainDelayedOrder
¶
Details
Signature
submitOffchainDelayedOrder(int256 sizeDelta, uint256 desiredFillPrice)
Visibility
external
State Mutability
``
submitOffchainDelayedOrderWithTracking
¶
Details
Signature
submitOffchainDelayedOrderWithTracking(int256 sizeDelta, uint256 desiredFillPrice, bytes32 trackingCode)
Visibility
external
State Mutability
``
transferMargin
¶
Details
Signature
transferMargin(int256 marginDelta)
Visibility
external
State Mutability
``
withdrawAllMargin
¶
Details
Signature
withdrawAllMargin()
Visibility
external
State Mutability
``
Events¶
DelayedOrderRemoved
¶
Signature: DelayedOrderRemoved(address account, bool isOffchain, uint256 currentRoundId, int256 sizeDelta, uint256 targetRoundId, uint256 commitDeposit, uint256 keeperDeposit, bytes32 trackingCode)
DelayedOrderSubmitted
¶
Signature: DelayedOrderSubmitted(address account, bool isOffchain, int256 sizeDelta, uint256 targetRoundId, uint256 intentionTime, uint256 executableAtTime, uint256 commitDeposit, uint256 keeperDeposit, bytes32 trackingCode)
FundingRecomputed
¶
Signature: FundingRecomputed(int256 funding, int256 fundingRate, uint256 index, uint256 timestamp)
MarginTransferred
¶
Signature: MarginTransferred(address account, int256 marginDelta)
PerpsTracking
¶
Signature: PerpsTracking(bytes32 trackingCode, bytes32 baseAsset, bytes32 marketKey, int256 sizeDelta, uint256 fee)
PositionFlagged
¶
Signature: PositionFlagged(uint256 id, address account, address flagger, uint256 price, uint256 timestamp)
PositionLiquidated
¶
Signature: PositionLiquidated(uint256 id, address account, address liquidator, int256 size, uint256 price, uint256 flaggerFee, uint256 liquidatorFee, uint256 stakersFee)
PositionModified
¶
Signature: PositionModified(uint256 id, address account, uint256 margin, int256 size, int256 tradeSize, uint256 lastPrice, uint256 fundingIndex, uint256 fee, int256 skew)