Home

Documentation:

https://docs.liquidpad.io/

ILOManager

Git Source

Inherits: IILOManager, Ownable

State Variables

DEFAULT_DEADLINE_OFFSET

uint64 private DEFAULT_DEADLINE_OFFSET = 7 * 24 * 60 * 60;

BPS

uint16 constant BPS = 10000;

PLATFORM_FEE

uint16 PLATFORM_FEE;

ILO_POOL_IMPLEMENTATION

address ILO_POOL_IMPLEMENTATION;

_uniV3Factory

address private _uniV3Factory;

_cachedProject

mapping(address => Project) private _cachedProject;

_initializedILOPools

mapping(address => address[]) private _initializedILOPools;

Functions

constructor

constructor(address initialOwner, address uniV3Factory, uint16 platformFee);

onlyProjectAdmin

modifier onlyProjectAdmin(address uniV3Pool);

initProject

init project with details

function initProject(
    address saleToken,
    address raiseToken,
    uint24 fee,
    uint160 initialPoolPriceX96,
    uint64 launchTime,
    uint16 investorShares,
    ProjectVestConfig[] calldata projectVestConfigs
) external override returns (address uniV3PoolAddress);

Parameters

Name	Type	Description
saleToken	address	the sale token
raiseToken	address	the raise token
fee	uint24	uniswap v3 fee tier
initialPoolPriceX96	uint160	uniswap sqrtPriceX96 for initialize pool
launchTime	uint64	time for lauch all liquidity. Only one launch time for all ilo pools
investorShares	uint16	number of liquidity shares after investor invest into ilo pool interm of BPS = 10000
projectVestConfigs	ProjectVestConfig[]	config for all other shares and vest

Returns

Name	Type	Description
uniV3PoolAddress	address	address of uniswap v3 pool. We use this address as project id

project

function project(address uniV3PoolAddress) external view override returns (Project memory);

initILOPool

this function init an ILO Pool which will be used for sale and vest. One project can init many ILO Pool

only project admin can use this function

function initILOPool(InitPoolParams calldata params) external override onlyProjectAdmin(params.uniV3Pool);

Parameters

Name	Type	Description
params	InitPoolParams	the parameters for init project

_initUniV3PoolIfNecessary

function _initUniV3PoolIfNecessary(PoolAddress.PoolKey memory poolKey, uint160 sqrtPriceX96)
    internal
    returns (address pool);

_cacheProject

function _cacheProject(
    address uniV3PoolAddress,
    address saleToken,
    address raiseToken,
    uint24 fee,
    uint160 initialPoolPriceX96,
    uint64 launchTime,
    uint64 refundDeadline,
    uint16 investorShares,
    ProjectVestConfig[] calldata projectVestConfigs
) internal;

_validateSharesPercentage

function _validateSharesPercentage(uint16 investorShares, ProjectVestConfig[] calldata projectVestConfigs)
    internal
    pure;

_validateVestSchedule

function _validateVestSchedule(LinearVest[] memory vestSchedule) internal pure;

setPlatformFee

set platform fee for decrease liquidity. Platform fee is imutable among all project's pools

function setPlatformFee(uint16 _platformFee) external onlyOwner;

setILOPoolImplementation

new ilo implementation for clone

function setILOPoolImplementation(address iloPoolImplementation) external onlyOwner;

transferAdminProject

transfer admin of project

function transferAdminProject(address admin, address uniV3Pool) external;

setDefaultDeadlineOffset

set time offset for refund if project not launch

function setDefaultDeadlineOffset(uint64 defaultDeadlineOffset) external onlyOwner;

setRefundDeadlineForProject

function setRefundDeadlineForProject(address uniV3Pool, uint64 refundDeadline) external onlyOwner;

Events

PoolImplementationChanged

event PoolImplementationChanged(address indexed oldPoolImplementation, address indexed newPoolImplementation);

ProjectAdminChanged

event ProjectAdminChanged(address indexed uniV3PoolAddress, address oldAdmin, address newAdmin);

ILOPool

Git Source

Inherits: ERC721, IILOPool, ILOSale, ILOVest, Initializable, Multicall, ILOPoolImmutableState, PoolInitializer, LiquidityManagement, PeripheryValidation

Wraps Uniswap V3 positions in the ERC721 non-fungible token interface

State Variables

investorVestConfigs

LinearVest[] investorVestConfigs;

_positions

The token ID position data

mapping(uint256 => Position) private _positions;

_nextId

The ID of the next token that will be minted. Skips 0

uint256 private _nextId = 1;

totalRaised

uint256 totalRaised;

Functions

constructor

constructor(address _factory, address _WETH9)
    ERC721("KRYSTAL ILOPool V1", "KYRSTAL-ILO-V1")
    ILOPoolImmutableState(_factory, _WETH9);

initialize

function initialize(InitPoolParams calldata params) external override whenNotInitialized;

positions

Returns the position information associated with a given token ID.

Throws if the token ID is not valid.

function positions(uint256 tokenId)
    external
    view
    override
    returns (
        address token0,
        address token1,
        uint24 fee,
        int24 tickLower,
        int24 tickUpper,
        uint128 liquidity,
        uint256 feeGrowthInside0LastX128,
        uint256 feeGrowthInside1LastX128,
        uint128 tokensOwed0,
        uint128 tokensOwed1
    );

Parameters

Name	Type	Description
tokenId	uint256	The ID of the token that represents the position

Returns

Name	Type	Description
token0	address	The address of the token0 for a specific pool
token1	address	The address of the token1 for a specific pool
fee	uint24	The fee associated with the pool
tickLower	int24	The lower end of the tick range for the position
tickUpper	int24	The higher end of the tick range for the position
liquidity	uint128	The liquidity of the position
feeGrowthInside0LastX128	uint256	The fee growth of token0 as of the last action on the individual position
feeGrowthInside1LastX128	uint256	The fee growth of token1 as of the last action on the individual position
tokensOwed0	uint128	The uncollected amount of token0 owed to the position as of the last computation
tokensOwed1	uint128	The uncollected amount of token1 owed to the position as of the last computation

buy

function buy(BuyParams calldata params)
    external
    override
    duringSale
    returns (uint256 tokenId, uint128 liquidityDelta, uint256 amountAdded0, uint256 amountAdded1);

isAuthorizedForToken

modifier isAuthorizedForToken(uint256 tokenId);

decreaseLiquidity

Decreases the amount of liquidity in a position and accounts it to the position

function decreaseLiquidity(DecreaseLiquidityParams calldata params)
    external
    payable
    override
    isAuthorizedForToken(params.tokenId)
    checkDeadline(params.deadline)
    returns (uint256 amount0, uint256 amount1);

Parameters

Name	Type	Description
params	DecreaseLiquidityParams	tokenId The ID of the token for which liquidity is being decreased, amount The amount by which liquidity will be decreased, amount0Min The minimum amount of token0 that should be accounted for the burned liquidity, amount1Min The minimum amount of token1 that should be accounted for the burned liquidity, deadline The time by which the transaction must be included to effect the change

Returns

Name	Type	Description
amount0	uint256	The amount of token0 accounted to the position's tokens owed
amount1	uint256	The amount of token1 accounted to the position's tokens owed

collect

Collects up to a maximum amount of fees owed to a specific position to the recipient

function collect(CollectParams calldata params)
    external
    payable
    override
    isAuthorizedForToken(params.tokenId)
    returns (uint256 amount0, uint256 amount1);

Parameters

Name	Type	Description
params	CollectParams	tokenId The ID of the NFT for which tokens are being collected, recipient The account that should receive the tokens, amount0Max The maximum amount of token0 to collect, amount1Max The maximum amount of token1 to collect

Returns

Name	Type	Description
amount0	uint256	The amount of fees collected in token0
amount1	uint256	The amount of fees collected in token1

burn

Burns a token ID, which deletes it from the NFT contract. The token must have 0 liquidity and all tokens must be collected first.

function burn(uint256 tokenId) external payable override isAuthorizedForToken(tokenId);

Parameters

Name	Type	Description
tokenId	uint256	The ID of the token that is being burned

launch

function launch() external override afterSale;

totalSold

function totalSold() public view returns (uint256);

_saleAmountNeeded

function _saleAmountNeeded(uint256 raiseAmount) internal view returns (uint256);

_unlockedLiquidity

function _unlockedLiquidity(uint256 tokenId) internal view override returns (uint128 unlockedLiquidity);

_assignVestingSchedule

function _assignVestingSchedule(uint256 nftId, LinearVest[] storage vestingSchedule) internal;

_updateVestingLiquidity

function _updateVestingLiquidity(uint256 nftId, uint128 liquidity) internal;

Structs

Position

struct Position {
    uint128 liquidity;
    uint256 feeGrowthInside0LastX128;
    uint256 feeGrowthInside1LastX128;
    uint128 tokensOwed0;
    uint128 tokensOwed1;
}