Function: redeem(uint256 shares, address receiver, address controller)

This function transfers a user's assets owed for a previously fulfilled redemption request.

Inputs

• shares

  • Control: Fully controlled by the caller.

  • Constraints: This must match the claimable redeem request.

  • Impact: The amount of shares to be claimed.

• receiver

  • Control: Fully controlled by the caller.

  • Constraints: None at this level.

  • Impact: The address to receive the assets.

• controller

  • Control: Fully controlled by the caller.

  • Constraints: The caller must be the controller or an operator of the controller.

  • Impact: The address of the controller of the redeem request.

Branches and code coverage

Intended branches

• Set redeemRequest.redeemShares[controller] to zero.

  Test coverage

• Transfer assets to receiver.

  Test coverage

Negative behavior

• Revert if shares is zero.

  Negative test

• Revert if the caller is not the controller or an operator of the controller.

  Negative test

• Revert if shares does not match the claimable redeem request.

  Negative test

Function call analysis

• this._claimRedemption(redeemRequest, assets, shares, receiver, controller) -> SafeERC20.safeTransfer(IERC20(this.asset()), receiver, assets)

  • What is controllable? assets, receiver, and controller — shares is partially controllable by the caller.

  • If the return value is controllable, how is it used and how can it go wrong? N/A.

  • What happens if it reverts, reenters or does other unusual control flow? N/A.