Comment on page

Liquidity Pool

setHandler

Admin function to set handlers
function setHandler(address _handler, bool _isActive)

setMaxLiquidity

Admin function to set max liquidity
function setMaxLiquidity(uint256 _maxLiquidity)

Provide

Public function to add liquidity
function provide(uint256 tokenXAmount, uint256 minMint)

provideForAccount

Handler only function to add liquidity for an account
function provideForAccount(
uint256 tokenXAmount,
uint256 minMint,
address account
)

Withdraw

Public function to remove liquidity
function withdraw(uint256 tokenXAmount)

withdrawForAccount

Handler only function to remove liquidity for an account
function withdrawForAccount(uint256 tokenXAmount, address account)

toTokenX

Returns tokenX equivalent of a certain amount BLP
function toTokenX(uint256 amount)

getUnlockedLiquidity

Returns available liquidity
function getUnlockedLiquidity(address account)

shareOf

Returns provider's share in tokenX
function shareOf(address account)

availableBalance

Returns the amount of tokenX available for withdrawals
function availableBalance()

totalTokenXBalance

Returns the total balance of tokenX provided to the pool
function totalTokenXBalance()