PoolCore

Git Source

Inherits: IPoolCore, PoolInternal, ReentrancyGuard

Functions

constructor

constructor(
    address factory,
    address router,
    address wrappedNativeToken,
    address feeReceiver,
    address referral,
    address settings,
    address vaultRegistry,
    address vxPremia
) PoolInternal(factory, router, wrappedNativeToken, feeReceiver, referral, settings, vaultRegistry, vxPremia);

marketPrice

Get the current market price as normalized price

function marketPrice() external view returns (UD60x18);

Returns

takerFee

Calculates the fee for a trade based on the size and premium of the trade

function takerFee(address taker, UD60x18 size, uint256 premium, bool isPremiumNormalized, bool isOrderbook)
    external
    view
    returns (uint256);

Parameters

Returns

_takerFeeLowLevel

Calculates the fee for a trade based on the size and premiumNormalized of the trade.

WARNING: It is recommended to use takerFee instead of this function. This function is a lower level function here to be used when a pool has not yet be deployed, by calling it from the diamond contract directly rather than a pool proxy. If using it from the pool, you should pass the same value as the pool for strike and isCallPool in order to get the accurate takerFee

function _takerFeeLowLevel(
    address taker,
    UD60x18 size,
    UD60x18 premium,
    bool isPremiumNormalized,
    bool isOrderbook,
    UD60x18 strike,
    bool isCallPool
) external view returns (UD60x18);

Parameters

Returns

getPoolSettings

Returns all pool parameters used for deployment

function getPoolSettings()
    external
    view
    returns (address base, address quote, address oracleAdapter, UD60x18 strike, uint256 maturity, bool isCallPool);

Returns

ticks

Returns all ticks in the pool, including net liquidity for each tick

function ticks() external view returns (IPoolInternal.TickWithRates[] memory);

Returns

claim

Updates the claimable fees of a position and transfers the claimed fees to the operator of the position. Then resets the claimable fees to zero.

function claim(Position.Key calldata p) external nonReentrant returns (uint256);

Parameters

Returns

getClaimableFees

Returns total claimable fees for the position

function getClaimableFees(Position.Key calldata p) external view returns (uint256);

Parameters

Returns

writeFrom

Underwrite an option by depositing collateral. By default the taker fee and referral are applied to the underwriter, if the caller is a registered vault the longReceiver is used instead.

function writeFrom(address underwriter, address longReceiver, UD60x18 size, address referrer) external nonReentrant;

Parameters

annihilate

Annihilate a pair of long + short option contracts to unlock the stored collateral.

This function can be called post or prior to expiration.

function annihilate(UD60x18 size) external nonReentrant;

Parameters

annihilateFor

Annihilate a pair of long + short option contracts to unlock the stored collateral on behalf of another account. msg.sender must be approved through UserSettings.setAuthorizedAddress by the owner of the long/short contracts.

This function can be called post or prior to expiration.

function annihilateFor(address account, UD60x18 size) external nonReentrant;

Parameters

exercise

Exercises all long options held by caller

function exercise() external nonReentrant returns (uint256 exerciseValue, uint256 exerciseFee);

Returns

exerciseFor

Batch exercises all long options held by each holder, caller is reimbursed with the cost deducted from the proceeds of the exercised options. Only authorized agents may execute this function on behalf of the option holder.

function exerciseFor(address[] calldata holders, uint256 costPerHolder)
    external
    nonReentrant
    returns (uint256[] memory exerciseValues, uint256[] memory exerciseFees);

Parameters

Returns

settle

Settles all short options held by caller

function settle() external nonReentrant returns (uint256 collateral);

Returns

settleFor

Batch settles all short options held by each holder, caller is reimbursed with the cost deducted from the proceeds of the settled options. Only authorized operators may execute this function on behalf of the option holder.

function settleFor(address[] calldata holders, uint256 costPerHolder)
    external
    nonReentrant
    returns (uint256[] memory collateral);

Parameters

Returns

settlePosition

Reconciles a user's position to account for settlement payouts post-expiration.

function settlePosition(Position.Key calldata p) external nonReentrant returns (uint256 collateral);

Parameters

Returns

settlePositionFor

Batch reconciles each position to account for settlement payouts post-expiration. Caller is reimbursed with the cost deducted from the proceeds of the settled position. Only authorized operators may execute this function on behalf of the option holder.

function settlePositionFor(Position.Key[] calldata p, uint256 costPerHolder)
    external
    nonReentrant
    returns (uint256[] memory collateral);

Parameters

Returns

transferPosition

Transfer a LP position to a new owner/operator

function transferPosition(Position.Key calldata srcP, address newOwner, address newOperator, UD60x18 size)
    external
    nonReentrant;

Parameters

tryCacheSettlementPrice

Attempts to cache the settlement price of the option after expiration. Reverts if a price has already been cached

function tryCacheSettlementPrice() external;

getSettlementPrice

Returns the settlement price of the option.

function getSettlementPrice() external view returns (UD60x18);

Returns

getStrandedArea

Gets the lower and upper bound of the stranded market area when it exists. In case the stranded market area does not exist it will return the stranded market area the maximum tick price for both the lower and the upper, in which case the market price is not stranded given any range order info order.

function getStrandedArea() external view returns (UD60x18 lower, UD60x18 upper);

Returns

getTokenIds

Returns the list of existing tokenIds with non zero balance

function getTokenIds() external view returns (uint256[] memory);

Returns