Function: claimSponsorFee(address basketToken)

This function is used to claim the sponsor fee for a given basket token.

Inputs

• basketToken

  • Control: Fully controlled by the sponsor or admin.

  • Constraints: basketToken must have the _BASKET_TOKEN_ROLE role.

  • Impact: The basket token to claim the sponsor fee for.

Branches and code coverage

Intended branches

• Update claimableSponsorFees for the given basketToken with zero.

  Test coverage

• Call BasketToken(basketToken).proRataRedeem(fee, sponsor, address(this)).

  Test coverage

Negative behavior

• Revert if basketToken does not have the _BASKET_TOKEN_ROLE role.

  Negative test

• Revert if the caller is not the sponsor or an admin.

  Negative test

Function call analysis

• this._checkIfBasketToken(basketToken) -> this._basketManager.hasRole(FeeCollector._BASKET_TOKEN_ROLE, token)

  • What is controllable? basketToken.

  • 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.

• BasketToken(basketToken).proRataRedeem(fee, sponsor, address(this))

  • What is controllable? basketToken and sponsor.

  • 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.