Create Position

Is a function used to create a Position.

User must provide the following arguments:

• collateral - the amount of collateral in uint256.
• size - the amount of size in uint256.
• long - if the Position is long (true) or short (false) in bool.

Requirements

• #8
• #9

Logic

• Check if collateral is greater than 0.
• Check if size is greater than 0.
• Check if user has enough collateral asset balance.
• Check if the leverage is lower than the max leverage.
• Check if the liquidity pool has enough liquidity to cover profits
• Create a new Position with the provided collateral, size, long and store entryPrice inside the Position.
• Increase collateral to the total traders deposits.

Long Position-specific

• Increase size to the open long interests in size and size price in assets to the open long interests.

Short Position-specific

• Increase size to the open short interests in size and size price in assets to the open short interests.

Remove Liquidity

Function to liquidity providers be able to remove their liquidity when they want.

Description

Split contracts into separated files:

• Vault.sol - ERC4626 Vault
• Positions.sol - Position Manager
• DataFeed.sol - Chainlink Data Feed Consumer

Close Position

Function to traders call when they want to close their open position.

Requirements

• #12
• #13
• #14

Add Liquidity

Liquidity Providers can use this function to provide liquidity to the protocol.

Positions

Positions are made up of the following:

• Size - how much “virtual” capital a trader is commanding, the size of a BTC perpetual position might be 1.5 BTC. If the price of BTC goes up, the trader is able to realize the profits earned on the 1.5 BTC in their position.
• Collateral - amount of assets used to “back” a trader’s position, when trader’s lose money, their losses come out of the collateral. If the amount of collateral is deemed insufficient for the size of a position, the position is liquidated or force closed.

Position struct

struct Position {
  uint256 collateral;
  uint256 size;
  uint256 entryPrice;
  bool long;
}

Where:

• collateral is the collateral used to back the trader's position.
• size is the virtual capital a trader is commanding.
• entryPrice the price of 1 size token in collateral token (ex.: 1 BTC in USD).
• long the Position is long (true) or short (false).

Functions

• #2
• #3
• #4
• #5
• #6
• #7