Add thoughts for possibility of start earning

[toninorair]

No description provided.

[github-actions]

LCOV of commit da7d764 during Forge Coverage #79

Summary coverage rate:
  lines......: 20.5% (27 of 132 lines)
  functions..: 17.0% (8 of 47 functions)
  branches...: no data found

Files changed coverage rate:
                           |Lines       |Functions  |Branches    
  Filename                 |Rate     Num|Rate    Num|Rate     Num
  ===============================================================
  src/WrappedM.sol         |13.9%    108|11.4%    35|    -      0

⛔ The code coverage is too low: 20.45. Expected at least 95.

[PierrickGT]

One issue I see with being able to start/stop when the wrapper is earning, is the difficulty to account for earned WM between earning and non earning period.
For example:

• at t0, the wrapper is earning and one user starts earning WM and we record the index at which he started earning
• at t1, the wrapper stops earning but the user is still earning and nobody calls stopEarningFor on behalf of the user
• at t2, the wrapper starts earning again, the user then decide to claim their yield. Since they haven't claimed or stopped earning before, their last recorded index is the one at t0 and the current index is the one at t2, so they can claim all the yield between t0 and t2 when they should only be able to claim the yield between t0 and t1.

One fix could be to store two indexes:

• the one when startEarningM was last called
• the one when stopEarningM was last called

This way, you could claim the yield between t0 and t1 as well as the yield between t2 and a future t3 but not in between t1 and t2. That being said, if you haven't claimed before stopEarningM is called again, you would forfeit any yield you haven't claimed.

[PierrickGT]

I don't think onlyWhenEarner is necessary since you can't be earning if the wrapper hasn't been earning in the past and you should be able to stop earning if the wrapper is not earning anymore.

Suggested change

	function stopEarningFor(address account_) external onlyWhenEarner {
	function stopEarningFor(address account_) external {

[PierrickGT]

Users should be able to wrap even if the wrapper is not currently earning.

Suggested change

	function wrap(address destination_, uint256 amount_) external onlyWhenEarner {
	function wrap(address destination_, uint256 amount_) external {

[PierrickGT]

Suggested change

	if (isEarner == true) revert NotInEarnerState();
	if (!isEarner) revert NotInEarnerState();

[toninorair]

One issue I see with being able to start/stop when the wrapper is earning, is the difficulty to account for earned WM between earning and non earning period. For example:

• at t0, the wrapper is earning and one user starts earning WM and we record the index at which he started earning
• at t1, the wrapper stops earning but the user is still earning and nobody calls stopEarningFor on behalf of the user
• at t2, the wrapper starts earning again, the user then decide to claim their yield. Since they haven't claimed or stopped earning before, their last recorded index is the one at t0 and the current index is the one at t2, so they can claim all the yield between t0 and t2 when they should only be able to claim the yield between t0 and t1.

One fix could be to store two indexes:

• the one when startEarningM was last called
• the one when stopEarningM was last called

This way, you could claim the yield between t0 and t1 as well as the yield between t2 and a future t3 but not in between t1 and t2. That being said, if you haven't claimed before stopEarningM is called again, you would forfeit any yield you haven't claimed.

good idea, worth experimenting with it for the next version