Function: depositERC20(uint256 amount, address depositor, address receiver)

This function is used to deposit ERC-20 tokens to the smart vault. It is expected to be called from the smart vault manager.

Inputs

• amount

  • Control: Fully controllable by the caller (smartVaultManager).

  • Constraints: Amount is not zero and is within the deposit cap.

  • Impact: Amount of token.

• depositor

  • Control: Fully controllable by the caller (smartVaultManager).

  • Constraints: Should be whitelisted when whitelist mode is enabled.

  • Impact: Address of the depositor.

• receiver

  • Control: Fully controllable by the caller (smartVaultManager).

  • Constraints: None.

  • Impact: Address of the share receiver.

Branches and code coverage

Intended branches

• Invoke the _beforeDeposit function.

  Test coverage

• Check if the current timestamp is within the deposit time range.

  Test coverage

• Check if the depositor is whitelisted when whitelist mode is enabled.

  Test coverage

• Check if the amount is within the deposit cap.

  Test coverage

• Check if the amount is within the deposit cap per user.

  Test coverage

• Update the reward for the receiver.

  Test coverage

• Invoke the _depositERC20 function.

  Test coverage

• Call the transferCallback function of smartVaultManager to get the underlying asset amount.

  Test coverage

• Update the total deposited underlying asset amount.

  Test coverage

• Update the shares for the receiver.

  Test coverage

• Emit the Deposit event.

  Test coverage

• Invoke the _manageDebtAndStake function.

  Test coverage

• Calculate the underlying token value using the manager's fetchPrice function.

  Test coverage

• Calculate the target staking amount using the staking factor.

  Test coverage

  • If the target is greater than the minted, mint the debt token and adjust the staking amount.

    Test coverage

  • If the target is less than the minted, burn the debt token and adjust the staking amount.

    Test coverage

Negative behavior

• Revert if the caller is not the manager.

  Negative test

• Revert if the contract is paused.

  Negative test

• Revert if the amount is zero.

  Negative test

• Revert if the depositor is not whitelisted when whitelist mode is enabled.

  Negative test

• Revert if the amount is within the deposit cap.

  Negative test

• Revert if the amount is within the deposit cap per user.

  Negative test

• Revert if minting/burning debt token fails.

  Negative test

Function call analysis

• this._depositERC20(amount, depositor, receiver) -> smartVaultManager.transferCallback(underlyingAsset, depositor, amount)

  • What is controllable? depositor and amount.

  • If the return value is controllable, how is it used and how can it go wrong? The return value is not used.

  • What happens if it reverts, reenters or does other unusual control flow? A revert indicates the transfer failed.

• this._manageDebtAndStake() -> this._calculateUnderlyingTokenValue() -> this._getAssetPrice() -> this.smartVaultManager.fetchPrice(this.underlyingAsset)

  • What is controllable? Nothing.

  • If the return value is controllable, how is it used and how can it go wrong? If the price feed fails to return the correct current market price, it would be critical to the vault's collateral calculation.

  • What happens if it reverts, reenters or does other unusual control flow? A revert indicates a failure in the oracle system, which prevents the vault from calculating the collateral asset value and thus causes it to malfunction.

• this._manageDebtAndStake() -> this._mintDebtToken(mintAmount) -> this.smartVaultManager.vaultMintDebtTokenCallback(amount)

  • What is controllable? amount.

  • If the return value is controllable, how is it used and how can it go wrong? The return value is not used.

  • What happens if it reverts, reenters or does other unusual control flow? A revert indicates the debt-token minting failed.

• this._manageDebtAndStake() -> this._mintDebtToken(mintAmount) -> this.smartVaultManager.debtToken().balanceOf(address(this))

  • What is controllable? Nothing.

  • If the return value is controllable, how is it used and how can it go wrong? Even without an actual token minting, the callback can still succeed.

  • What happens if it reverts, reenters or does other unusual control flow? A revert indicates the debt token is not a valid ERC-20 token.

• this._manageDebtAndStake() -> this._burnDebtToken(mintAmount) -> this.smartVaultManager.vaultBurnDebtTokenCallback(amount)

  • What is controllable? amount.

  • If the return value is controllable, how is it used and how can it go wrong? The return value is not used.

  • What happens if it reverts, reenters or does other unusual control flow? A revert indicates the debt-token burning failed.

• this._manageDebtAndStake() -> this._burnDebtToken(mintAmount) -> this.smartVaultManager.debtToken().balanceOf(address(this))

  • What is controllable? Nothing.

  • If the return value is controllable, how is it used and how can it go wrong? Even without an actual token burning, the callback can still succeed.

  • What happens if it reverts, reenters or does other unusual control flow? A revert indicates the debt token is not a valid ERC-20 token.

• this._manageDebtAndStake() -> this._adjustStaking(target) -> this._stakeDebtToken(stakeAmount) -> IStakingVault(stakingVault).deposit(amount, address(this))

  • What is controllable? stakingVault is set by smartVaultManager and amount but calculated by staking factor and the price of underlying asset.

  • If the return value is controllable, how is it used and how can it go wrong? The return value is not used.

  • What happens if it reverts, reenters or does other unusual control flow? A revert indicates the staking failed.

• this._manageDebtAndStake() -> this._adjustStaking(target) -> this._stakeDebtToken(stakeAmount) -> IStakingVault(smartVaultManager.stakingVault().withdraw(amount, address(this), address(this))

  • What is controllable? stakingVault set by smartVaultManager and amount but calculated by staking factor and the price of underlying asset.

  • If the return value is controllable, how is it used and how can it go wrong? The return value is not used.

  • What happens if it reverts, reenters or does other unusual control flow? A revert indicates the unstaking failed.