Position

Description

The Position contract represents one position of an individual user. A single user can own multiple Position contracts, each representing a different combination of collateral, debt, and base tokens.

Position contracts are deployed by the PositionFactory contract via the createPosition function.

Write Functions

add

Adds to the position.

🚨 This method requires the caller to approve the Position contract to spend _cAmt of the caller's C_TOKEN via the token's ERC-20 approve (opens in a new tab) function.

🚨 Fees are collected in terms of C_TOKEN.

function add(
    uint256 _cAmt,
    uint256 _ltv,
    uint256 _swapAmtOutMin,
    uint24 _poolFee,
    address _client
) external payable;

Input Parameters

addWithPermit

Adds to the position using an ERC-2612 (opens in a new tab) permit, obviating the need for a separate approve transaction.

🚨 Fees are collected in terms of C_TOKEN.

function addWithPermit(
    uint256 _cAmt,
    uint256 _ltv,
    uint256 _swapAmtOutMin,
    uint24 _poolFee,
    address _client,
    uint256 _deadline,
    uint8 _v,
    bytes32 _r,
    bytes32 _s
) external payable;

Input Parameters

addLeverage

Adds leverage to the position using the B_TOKEN balance on Aave.

🚨 Fees are collected in terms of D_TOKEN.

function addLeverage(
    uint256 _dAmt,
    uint256 _swapAmtOutMin,
    uint24 _poolFee,
    address _client
) external payable;

Input Parameters

reduce

Reduces a position based on the amount of B_TOKEN and C_TOKEN withdrawn.

🚨 The B_TOKEN is withdrawn from Aave and swapped for the D_TOKEN to repay the loan. Only profitable positions are able fully reduce the position and withdraw all funds.

function reduce(
    uint24 _poolFee,
    bool _exactOutput,
    uint256 _swapAmtOutMin,
    uint256 _withdrawCAmt,
    uint256 _withdrawBAmt
) external payable;

Input Parameters

addCollateral

Increases the collateral amount backing the Position contract's loan.

🚨 This method requires the caller to approve the Position contract to spend _cAmt of the caller's C_TOKEN via the token's ERC-20 approve (opens in a new tab) function.

function addCollateral(
    uint256 _cAmt
) external payable;

Input Parameters

addCollateralWithPermit

Increases the collateral amount backing the Position contract's loan using an ERC-2612 (opens in a new tab) permit, obviating the need for a separate approve transaction.

function addCollateralWithPermit(
    uint256 _cAmt
    uint256 _deadline,
    uint8 _v,
    bytes32 _r,
    bytes32 _s
) external payable;

Input Parameters

withdraw

Withdraws the specified amount of collateral from Aave and transfers it to the specified recipient.

🚨 INSTRUCTIONS ON HOW TO CALCULATE MAX C AMOUNT AND MAX B AMOUNT TO WITHDRAW HERE

function withdraw(
    address _token,
    uint256 _amt,
    address _recipient,
) external payable;

Input Parameters

repay

Repays outstanding debt to Aave.

One use-case for this function is when a position was not profitable and the amount of B_TOKEN was not enough to repay the loan. If the Position owner wants to retrieve any remaining collateral, more D_TOKEN must be acquired elsewhere to pay off the remaining debt via this function.

🚨 This method requires the caller to approve the Position contract to spend _dAmt of the caller's D_TOKEN via the token's ERC-20 approve (opens in a new tab) function.

function repay(
    uint256 _dAmt,
) external payable;

Input Parameters

repayAndWithdrawWithPermit

Repays outstanding debt to Aave using an ERC-2612 (opens in a new tab) permit, obviating the need for a separate approve transaction.

One use-case for this function is when a position was not profitable and the amount of B_TOKEN was not enough to repay the loan. If the Position owner wants to retrieve any remaining collateral, more D_TOKEN must be acquired elsewhere to pay off the remaining debt via this function.

function repayWithPermit(
    uint256 _dAmt,
    uint256 _deadline,
    uint8 _v,
    bytes32 _r,
    bytes32 _s
) external payable;

Input Parameters

extractNative

Allows the Position contract owner to withdraw all of the contract's native token balance.

function extractNative() external payable;

extractERC20

Allows the Position contract owner to withdraw all of a specified ERC-20 token balance from the contract.

extractERC20(address _token) external payable;

Input Parameters

Read Functions

FEE_COLLECTOR

Returns the address of the FeeCollector contract, which is responsible for collecting and allocating protocol fees.

function FEE_COLLECTOR() external view returns (address);

Output Parameters

OWNER

Returns the owner of the Position contract.

function OWNER() external view returns (address);

Output Parameters

C_TOKEN

Returns the address of the Position contract's collateral token.

function C_TOKEN() external view returns (address);

Output Parameters

D_TOKEN

Returns the address of the Position contract's debt token.

function D_TOKEN() external view returns (address);

Output Parameters

B_TOKEN

Returns the address of the Position contract's base token.

function B_TOKEN() external view returns (address);

Output Parameters

C_DECIMALS

Returns the number of decimals for the Position contract's collateral token.

function C_DECIMALS() external view returns (uint8);

Output Parameters

D_DECIMALS

Returns the number of decimals for the Position contract's debt token.

function D_DECIMALS() external view returns (uint8);

Output Parameters

B_DECIMALS

Returns the number of decimals for the Position contract's base token.

function B_DECIMALS() external view returns (uint8);

Output Parameters