Function: deposit(address depositContract, address depositToken, uint256 amount)

This function is used to deposit tokens into the target ERC-4626 vault and collect fees.

Inputs

• depositContract

  • Control: Arbitrary.

  • Constraints: Mapped in feeConfigs.

  • Impact: Address of the ERC-4626 vault.

• depositToken

  • Control: Arbitrary.

  • Constraints: Mapped in feeConfigs.

  • Impact: Address of the ERC-20 token to deposit.

• amount

  • Control: Arbitrary.

  • Constraints: Nonzero.

  • Impact: Amount of tokens to deposit.

Branches and code coverage

Intended branches

• Invoke computeFee to calculate the fee with amount.

  Test coverage

• Transfer the fee to the feeRecipient if feeRecipient exists.

  Test coverage

• Transfer the fee to the providerFeeRecipient.

  Test coverage

• Receive the deposit amount from msg.sender.

  Test coverage

• Call approve to depositContract with depositAmount.

  Test coverage

• Call depositContractInstance.deposit with depositAmount and msg.sender.

  Test coverage

Negative behavior

• Revert if amount is zero.

  Negative test

• Revert if depositContract and depositToken are not enabled in feeConfigs.

  Negative test

• Revert if the fee transfer to feeRecipient fails.

  Negative test

• Revert if the provider-fee transfer fails.

  Negative test

• Revert if the transfer deposit amount fails.

  Negative test

• Revert if the deposit token approval fails.

  Negative test

Function call analysis

• depositTokenInstance.transferFrom(msg.sender, feeConfig.feeRecipient, feeRecipientAmount)

  • What is controllable? feeRecipientAmount based on the user's deposit amount.

  • If the return value is controllable, how is it used and how can it go wrong? It could be executed if the transfer fails.

• depositTokenInstance.transferFrom(msg.sender, this.providerFeeRecipient, feeAmount)

  • What is controllable? feeAmount based on the user's deposit amount.

  • If the return value is controllable, how is it used and how can it go wrong? It could be executed if the transfer fails.

• depositTokenInstance.transferFrom(msg.sender, address(this), depositAmount)

  • What is controllable? depositAmount based on the user's deposit amount.

  • If the return value is controllable, how is it used and how can it go wrong? It could be executed if the transfer fails.

• depositTokenInstance.approve(depositContract, depositAmount)

  • What is controllable? depositAmount based on the user's deposit amount.

  • If the return value is controllable, how is it used and how can it go wrong? Transfer will fail in depositContractInstance.deposit.

• depositContractInstance.deposit(depositAmount, msg.sender)

  • What is controllable? depositAmount based on the user's deposit amount.

  • If the return value is controllable, how is it used and how can it go wrong? The share could be manipulated to return a different value.