PositionParam.sol

PositionParam

struct PositionParam {
  uint256 openVersion;
  uint256 closeVersion;
  int256 qty;
  uint256 takerMargin;
  uint256 makerMargin;
  uint256 openTimestamp;
  uint256 closeTimestamp;
  IOracleProvider.OracleVersion _entryVersionCache;
  IOracleProvider.OracleVersion _exitVersionCache;
}

A struct representing the parameters of a position.

Name	Type	Description
openVersion	uint256	The version of the position's open transaction
closeVersion	uint256	The version of the position's close transaction
qty	int256	The quantity of the position
takerMargin	uint256	The margin amount provided by the taker
makerMargin	uint256	The margin amount provided by the maker
openTimestamp	uint256	The timestamp of the position's open transaction
closeTimestamp	uint256	The timestamp of the position's close transaction
_entryVersionCache	IOracleProvider.OracleVersion	Caches the settled oracle version for the position's entry
_exitVersionCache	IOracleProvider.OracleVersion	Caches the settled oracle version for the position's exit

PositionParamLib

Library for manipulating PositionParam struct.

entryVersion

function entryVersion(struct PositionParam self) internal pure returns (uint256)

Returns the settled version for the position's entry.

• Parameters:

  Name	Type	Description
  self	struct PositionParam	The PositionParam struct.

• Return Values:

  Name	Type	Description
  [0]	uint256	uint256 The settle version for the position's entry.

entryPrice

function entryPrice(struct PositionParam self, struct LpContext ctx) internal view returns (uint256)

Calculates the entry price for a PositionParam.

• Parameters:

  Name	Type	Description
  self	struct PositionParam	The PositionParam struct.
  ctx	struct LpContext	The LpContext struct.

• Return Values:

  Name	Type	Description
  [0]	uint256	uint256 The entry price.

entryAmount

function entryAmount(struct PositionParam self, struct LpContext ctx) internal view returns (uint256)

Calculates the entry amount for a PositionParam.

• Parameters:

  Name	Type	Description
  self	struct PositionParam	The PositionParam struct.
  ctx	struct LpContext	The LpContext struct.

• Return Values:

  Name	Type	Description
  [0]	uint256	uint256 The entry amount.

entryOracleVersion

function entryOracleVersion(struct PositionParam self, struct LpContext ctx) internal view returns (struct IOracleProvider.OracleVersion)

Retrieves the settled oracle version for the position's entry.

• Parameters:

  Name	Type	Description
  self	struct PositionParam	The PositionParam struct.
  ctx	struct LpContext	The LpContext struct.

• Return Values:

  Name	Type	Description
  [0]	struct IOracleProvider.OracleVersion	OracleVersion The settle oracle version for the position's entry.

calculateInterest

function calculateInterest(struct PositionParam self, struct LpContext ctx, uint256 until) internal view returns (uint256)

Calculates the interest for a PositionParam until a specified timestamp. It is used only to deduct accumulated accrued interest when close position

• Parameters:

  Name	Type	Description
  self	struct PositionParam	The PositionParam struct.
  ctx	struct LpContext	The LpContext struct.
  until	uint256	The timestamp until which to calculate the interest.

• Return Values:

  Name	Type	Description
  [0]	uint256	uint256 The calculated interest.

clone

function clone(struct PositionParam self) internal pure returns (struct PositionParam)

Creates a clone of a PositionParam.

• Parameters:

  Name	Type	Description
  self	struct PositionParam	The PositionParam data struct.

• Return Values:

  Name	Type	Description
  [0]	struct PositionParam	PositionParam The cloned PositionParam.

inverse

function inverse(struct PositionParam self) internal pure returns (struct PositionParam)

Creates the inverse of a PositionParam by negating the qty.

• Parameters:

  Name	Type	Description
  self	struct PositionParam	The PositionParam data struct.

• Return Values:

  Name	Type	Description
  [0]	struct PositionParam	PositionParam The inverted PositionParam.