Function: claim(address _pool)

This function is used to allow a user to claim their shares from a specific pool.

Inputs

• _pool

  • Control: Arbitrary.

  • Constraints: Nonzero address.

  • Impact: Address of the pool from which to claim shares.

Branches and code coverage

Intended branches

• Get the bond token and coupon token from the pool.

  Test coverage

• Get the current period and the user's balance and calculate the user's shares.

  Test coverage

• Subtract the user's shares from the pool's amount to distribute and the coupon amounts to distribute.

  Test coverage

• Reset the user's indexed assets and transfer the user's shares to the user's address.

  Test coverage

Negative behavior

• Revert if the contract is paused.

  Negative test

• Revert if the pool address is zero.

  Negative test

• Revert if the address of the bond token or coupon token is zero.

  Negative test

• Revert if the coupon-token balance is less than the user's shares.

  Negative test

• Revert if the pool does not have enough shares to distribute.

  Negative test

• Revert if the distributor does not have enough coupon tokens to distribute.

  Negative test