Skip to content

Commit

Permalink
feat: M token burn only from msg.sender
Browse files Browse the repository at this point in the history
  • Loading branch information
@0xIryna
0xIryna committed Oct 4, 2024
1 parent eb451c8 commit 78484cc
Show file tree
Hide file tree
Showing 3 changed files with 39 additions and 95 deletions.
15 changes: 2 additions & 13 deletions src/MToken.sol
View file
Original file line number Diff line number Diff line change
Expand Up @@ -78,19 +78,8 @@ contract MToken is IMToken, ContinuousIndexing, ERC20Extended {
}

/// @inheritdoc IMToken
function burn(address account_, uint256 amount_) external onlyPortal {
uint256 portalAllowance_ = allowance[account_][portal];

if (portalAllowance_ != type(uint256).max) {
if (portalAllowance_ < amount_)
revert IERC20Extended.InsufficientAllowance(portal, portalAllowance_, amount_);

unchecked {
_setAllowance(account_, portal, portalAllowance_ - amount_);
}
}

_burn(account_, amount_);
function burn(uint256 amount_) external onlyPortal {
_burn(msg.sender, amount_);
}

/// @inheritdoc IContinuousIndexing
Expand Down
6 changes: 2 additions & 4 deletions src/interfaces/IMToken.sol
View file
Original file line number Diff line number Diff line change
Expand Up @@ -65,13 +65,11 @@ interface IMToken is IContinuousIndexing, IERC20Extended {
function mint(address account, uint256 amount, uint128 index) external;

/**
* @notice Burns `amount` of M tokens from `account`.
* @notice Burns `amount` of M tokens from `msg.sender`.
* @dev MUST only be callable by the Spoke Portal.
* @dev MUST revert if `account` has not approved the Spoke Portal to burn their M tokens.
* @param account The address of the account to burn from.
* @param amount The amount of M Token to burn.
*/
function burn(address account, uint256 amount) external;
function burn(uint256 amount) external;

/// @notice Starts earning for caller if allowed by TTG.
function startEarning() external;
Expand Down
113 changes: 35 additions & 78 deletions test/MToken.t.sol
View file
Original file line number Diff line number Diff line change
Expand Up @@ -204,84 +204,50 @@ contract MTokenTests is TestUtils {
/* ============ burn ============ */
function test_burn_notPortal() external {
vm.expectRevert(IMToken.NotPortal.selector);
_mToken.burn(_alice, 0);
_mToken.burn(0);
}

function test_burn_insufficientAmount() external {
vm.expectRevert(abi.encodeWithSelector(IERC20Extended.InsufficientAmount.selector, 0));
vm.prank(_portal);
_mToken.burn(_alice, 0);
_mToken.burn(0);
}

function test_burn_insufficientBalance_fromNonEarner() external {
_mToken.setInternalBalanceOf(_alice, 999);

vm.prank(_alice);
_mToken.approve(_portal, type(uint256).max);
_mToken.setInternalBalanceOf(_portal, 999);

vm.expectRevert(abi.encodeWithSelector(IMToken.InsufficientBalance.selector, _alice, 999, 1_000));
vm.expectRevert(abi.encodeWithSelector(IMToken.InsufficientBalance.selector, _portal, 999, 1_000));
vm.prank(_portal);
_mToken.burn(_alice, 1_000);
_mToken.burn(1_000);
}

function test_burn_insufficientBalance_fromEarner() external {
_mToken.setIsEarning(_alice, true);
_mToken.setInternalBalanceOf(_alice, 908);

vm.prank(_alice);
_mToken.approve(_portal, type(uint256).max);

vm.expectRevert(abi.encodeWithSelector(IMToken.InsufficientBalance.selector, _alice, 908, 910));
vm.prank(_portal);
_mToken.burn(_alice, 1_000);
}

function test_burn_insufficientAllowance() external {
uint256 amount_ = 1_000;

vm.expectRevert(abi.encodeWithSelector(IERC20Extended.InsufficientAllowance.selector, _portal, 0, amount_));

vm.prank(_portal);
_mToken.burn(_alice, amount_);
}

function test_burn_updateAllowance() external {
uint256 amount_ = 1_000;

_mToken.setInternalBalanceOf(_alice, amount_);

vm.prank(_alice);
_mToken.approve(_portal, amount_);

assertEq(_mToken.allowance(_alice, _portal), amount_);
_mToken.setIsEarning(_portal, true);
_mToken.setInternalBalanceOf(_portal, 909);

vm.expectRevert(abi.encodeWithSelector(IMToken.InsufficientBalance.selector, _portal, 909, 910));
vm.prank(_portal);
_mToken.burn(_alice, amount_);

assertEq(_mToken.allowance(_alice, _portal), 0);
_mToken.burn(1000);
}

function test_burn_fromNonEarner() external {
_mToken.setTotalNonEarningSupply(1_000);

_mToken.setInternalBalanceOf(_alice, 1_000);

vm.prank(_alice);
_mToken.approve(_portal, type(uint256).max);

_mToken.setInternalBalanceOf(_portal, 1_000);

vm.prank(_portal);
_mToken.burn(_alice, 500);
_mToken.burn(500);

assertEq(_mToken.internalBalanceOf(_alice), 500);
assertEq(_mToken.internalBalanceOf(_portal), 500);
assertEq(_mToken.totalNonEarningSupply(), 500);
assertEq(_mToken.principalOfTotalEarningSupply(), 0);
assertEq(_mToken.latestIndex(), _expectedCurrentIndex);
assertEq(_mToken.latestUpdateTimestamp(), _start);

vm.prank(_portal);
_mToken.burn(_alice, 500);
_mToken.burn(500);

assertEq(_mToken.internalBalanceOf(_alice), 0);
assertEq(_mToken.internalBalanceOf(_portal), 0);
assertEq(_mToken.totalNonEarningSupply(), 0);
assertEq(_mToken.principalOfTotalEarningSupply(), 0);
assertEq(_mToken.latestIndex(), _expectedCurrentIndex);
Expand All @@ -293,24 +259,21 @@ contract MTokenTests is TestUtils {
vm.assume(supply_ % 2 == 0);

_mToken.setTotalNonEarningSupply(supply_);
_mToken.setInternalBalanceOf(_alice, supply_);

vm.prank(_alice);
_mToken.approve(_portal, type(uint256).max);
_mToken.setInternalBalanceOf(_portal, supply_);

vm.prank(_portal);
_mToken.burn(_alice, supply_ / 2);
_mToken.burn(supply_ / 2);

assertEq(_mToken.internalBalanceOf(_alice), supply_ / 2);
assertEq(_mToken.internalBalanceOf(_portal), supply_ / 2);
assertEq(_mToken.totalNonEarningSupply(), supply_ / 2);
assertEq(_mToken.principalOfTotalEarningSupply(), 0);
assertEq(_mToken.latestIndex(), _expectedCurrentIndex);
assertEq(_mToken.latestUpdateTimestamp(), _start);

vm.prank(_portal);
_mToken.burn(_alice, supply_ / 2);
_mToken.burn(supply_ / 2);

assertEq(_mToken.internalBalanceOf(_alice), 0);
assertEq(_mToken.internalBalanceOf(_portal), 0);
assertEq(_mToken.totalNonEarningSupply(), 0);
assertEq(_mToken.principalOfTotalEarningSupply(), 0);
assertEq(_mToken.latestIndex(), _expectedCurrentIndex);
Expand All @@ -320,26 +283,23 @@ contract MTokenTests is TestUtils {
function test_burn_fromEarner() external {
_mToken.setPrincipalOfTotalEarningSupply(909);

_mToken.setIsEarning(_alice, true);
_mToken.setInternalBalanceOf(_alice, 909);

vm.prank(_alice);
_mToken.approve(_portal, type(uint256).max);
_mToken.setIsEarning(_portal, true);
_mToken.setInternalBalanceOf(_portal, 909);

vm.prank(_portal);
_mToken.burn(_alice, 1);
_mToken.burn(1);

// Change due to principal round up on burn.
assertEq(_mToken.internalBalanceOf(_alice), 908);
assertEq(_mToken.internalBalanceOf(_portal), 908);
assertEq(_mToken.totalNonEarningSupply(), 0);
assertEq(_mToken.principalOfTotalEarningSupply(), 908);
assertEq(_mToken.latestIndex(), _expectedCurrentIndex);
assertEq(_mToken.latestUpdateTimestamp(), _start);

vm.prank(_portal);
_mToken.burn(_alice, 998);
_mToken.burn(998);

assertEq(_mToken.internalBalanceOf(_alice), 0);
assertEq(_mToken.internalBalanceOf(_portal), 0);
assertEq(_mToken.totalNonEarningSupply(), 0);
assertEq(_mToken.principalOfTotalEarningSupply(), 0);
assertEq(_mToken.latestIndex(), _expectedCurrentIndex);
Expand All @@ -354,38 +314,35 @@ contract MTokenTests is TestUtils {

_mToken.setPrincipalOfTotalEarningSupply(expectedPrincipalBalance_);

_mToken.setIsEarning(_alice, true);
_mToken.setInternalBalanceOf(_alice, expectedPrincipalBalance_);
_mToken.setIsEarning(_portal, true);
_mToken.setInternalBalanceOf(_portal, expectedPrincipalBalance_);

uint256 burnAmount_ = _mToken.balanceOf(_alice) / 2;
uint256 burnAmount_ = _mToken.balanceOf(_portal) / 2;
vm.assume(burnAmount_ != 0);

vm.prank(_alice);
_mToken.approve(_portal, type(uint256).max);

vm.prank(_portal);
_mToken.burn(_alice, burnAmount_);
_mToken.burn(burnAmount_);

expectedPrincipalBalance_ -= _getPrincipalAmountRoundedUp(uint240(burnAmount_), _expectedCurrentIndex);

// Change due to principal round up on burn.
assertEq(_mToken.internalBalanceOf(_alice), expectedPrincipalBalance_);
assertEq(_mToken.internalBalanceOf(_portal), expectedPrincipalBalance_);
assertEq(_mToken.totalNonEarningSupply(), 0);
assertEq(_mToken.principalOfTotalEarningSupply(), expectedPrincipalBalance_);
assertEq(_mToken.latestIndex(), _expectedCurrentIndex);
assertEq(_mToken.latestUpdateTimestamp(), _start);

uint256 balanceOfAlice_ = _mToken.balanceOf(_alice);
uint256 balanceOfPortal_ = _mToken.balanceOf(_portal);

assertEq(
_mToken.balanceOf(_alice),
_mToken.balanceOf(_portal),
_getPresentAmountRoundedDown(uint112(expectedPrincipalBalance_), _expectedCurrentIndex)
);

vm.prank(_portal);
_mToken.burn(_alice, balanceOfAlice_);
_mToken.burn(balanceOfPortal_);

assertEq(_mToken.internalBalanceOf(_alice), 0);
assertEq(_mToken.internalBalanceOf(_portal), 0);
assertEq(_mToken.totalNonEarningSupply(), 0);
assertEq(_mToken.principalOfTotalEarningSupply(), 0);
assertEq(_mToken.latestIndex(), _expectedCurrentIndex);
Expand Down

0 comments on commit 78484cc

Please sign in to comment.