Fund contract implementation

1. Functions

1.1. deposit

  function deposit(
    uint256 amount
  ) external returns (uint256 share)

The user deposits the local token of the fund

The deposit function is suitable for ERC20 funds, if it is an ETH fund (internally converted to WETH9), it should be directly transferred to the fund contract.

Parameters:

Return Values:

1.2. _deposit

  function _deposit(
    uint amount, 
    uint total_assets
  ) internal returns (uint256 share)

Store user deposit status.

Returns fund share amount.

Parameters:

1.3. receive

  function receive() external payable

Used to receive user ETH investment

1.4. withdraw

  function withdraw(
    uint256 share,
    uint256 amountMin,
    uint256 deadline
  ) external returns (uint256 amount)

The user withdraws some local token of the specified share

Parameters:

Return Values:

1.5. poolsLength

  function poolsLength() external returns (uint256)

Get pool array length

1.6. positionsLength

  function positionsLength(
    uint256 poolIndex
  ) external returns (uint256)

Get the length of the position array of the pool

Parameters:

1.7. setDescriptor

  function setDescriptor(
    bytes _descriptor
  ) external

Set fund description information

This function can only be called by controller

Parameters:

1.8. setDepositDeadline

  function setDepositDeadline(
    uint256 deadline
  ) external

Set countdown timestamp for fund deposit

This function can only be called by controller

Parameters:

1.9. setPath

  function setPath(
    address distToken,
    bytes buy,
    bytes sell
  ) external

Set the token swap path

To modify sellPath, you need to clear the relevant pool position assets first

Parameters:

1.10. uniswapV3MintCallback

  function uniswapV3MintCallback(
    uint256 amount0Owed,
    uint256 amount1Owed,
    bytes data
  ) external

Called to msg.sender after minting liquidity to a position from IUniswapV3Pool#mint.

In the implementation you must pay the pool tokens owed for the minted liquidity. The caller of this method must be checked to be a UniswapV3Pool deployed by the canonical UniswapV3Factory.

Parameters:

1.11. init

  function init(
    address token0,
    address token1,
    uint24 fee,
    int24 tickLower,
    int24 tickUpper,
    uint256 amount,
    uint32 maxPIS
  ) external returns (uint128 liquidity)

Initialize the position and allow the investment amount to be 0.

This function can only be called by controller

Parameters:

Return Values:

1.12. add

  function add(
    uint256 poolIndex,
    uint256 positionIndex,
    uint256 amount,
    bool collect,
    uint32 maxPIS
  ) external returns (uint128 liquidity)

Investment in designated positions, optional reinvestment fee

This function can only be called by controller

Parameters:

Return Values:

1.13. sub

  function sub(
    uint256 poolIndex,
    uint256 positionIndex,
    uint256 proportionX128,
    uint32 maxPIS
  ) external returns (uint256 amount)

Divestment of designated positions

This function can only be called by controller

Parameters:

Return Values:

1.14. move

  function move(
    uint256 poolIndex,
    uint256 subIndex,
    uint256 addIndex,
    uint256 proportionX128,
    uint32 maxPIS
  ) external returns (uint128 liquidity)

Move position investment

This function can only be called by controller

Parameters:

Return Values:

1.15. assetsOfPosition

  function assetsOfPosition(
    uint256 poolIndex,
    uint256 positionIndex
  ) public returns (uint256 amount)

Get the number of assets in the specified position

Parameters:

1.16. assetsOfPool

  function assetsOfPool(
    uint256 poolIndex
  ) public returns (uint256 amount)

Get the amount of assets in the specified pool

Parameters:

1.17. totalAssets

  function totalAssets() public returns (uint256 amount)

Get total assets of fund

Amount of total assets denominated in fund local token

1.18. _assetsOfPool

  function _assetsOfPool(
    uint poolIndex
  ) internal returns (uint256 amount, uint256[])

Get assets of specified pool

Parameters: