基金合约实现

1. Functions

1.1. deposit

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

用户存入基金的本币。

充值功能适用于ERC20资金，如果是ETH资金（内部转为WETH9），直接转入ETH给合约即可。

Parameters:

Return Values:

1.2. _deposit

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

保存用户基金存入状态信息。

返回基金份额信息。

Parameters:

1.3. receive

  function receive() external payable

用户直接转账ETH进行投资

1.4. withdraw

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

用户提取指定份额的投资

Parameters:

Return Values:

1.5. poolsLength

  function poolsLength() external returns (uint256)

获取池子数组长度

1.6. positionsLength

  function positionsLength(
    uint256 poolIndex
  ) external returns (uint256)

获取指定池子的头寸数组长度

Parameters:

1.7. setDescriptor

  function setDescriptor(
    bytes _descriptor
  ) external

设置基金的描述信息，32 bytes的基金名称 + 任意长度的基金描述。

该函数只能被控制器调用。

Parameters:

1.8. setDepositDeadline

  function setDepositDeadline(
    uint256 deadline
  ) external

设置基金可存入的截止时间。

该函数只能被控制器调用。

Parameters:

1.9. setPath

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

设置基金中的代币交易路径。

修改sellPath需要先清空相关池子的资产。

Parameters:

1.10. uniswapV3MintCallback

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

在从 IUniswapV3Pool#mint 将流动性铸造到头寸指定后回调 msg.sender的该方法，以处理后续转账操作。

在实施中，您必须支付因铸造流动性而欠下的池子代币。 必须检查此方法的调用者是否是由规范 UniswapV3Factory 部署的 UniswapV3Pool。

Parameters:

1.11. init

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

初始化一个基金头寸，investment大于0时会投资该数量的基金本币到该头寸。

该函数只能被控制器调用。

Parameters:

Return Values:

1.12. add

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

投资指定头寸，可选择是否复投之前的收益。

该函数只能被控制器调用。

Parameters:

Return Values:

1.13. sub

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

撤资指定的头寸。

该函数只能被控制器调用。

Parameters:

Return Values:

1.14. move

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

调整头寸资金，从一个头寸移动到另一个头寸。

该函数只能被控制器调用。

Parameters:

Return Values:

1.15. assetsOfPosition

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

获取指定头寸的资产数量

Parameters:

1.16. assetsOfPool

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

获取指定池子的资产数量

Parameters:

1.17. totalAssets

  function totalAssets() public returns (uint256 amount)

获取基金总的资产。

以基金本币计价的总资产金额。

1.18. _assetsOfPool

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

获取指定池子的资产

Parameters: