Feat/mtoken min balance #242
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,62 @@ | ||
| // SPDX-License-Identifier: MIT | ||
| pragma solidity 0.8.9; | ||
|
|
||
| import "./mToken.sol"; | ||
|
|
||
| /** | ||
| * @title mTokenMinBalance | ||
| * @notice mToken with minimum balance checks | ||
| * @author RedDuck Software | ||
| */ | ||
| //solhint-disable contract-name-camelcase | ||
| abstract contract mTokenMinBalance is mToken { | ||
| /** | ||
| * @dev leaving a storage gap for futures updates | ||
| */ | ||
| uint256[50] private __gap; | ||
|
|
||
| /** | ||
| * @dev overrides _afterTokenTransfer function to check if the recipient has a minimum balance | ||
| */ | ||
| function _afterTokenTransfer( | ||
| address from, | ||
| address to, | ||
| uint256 amount | ||
| ) internal virtual override { | ||
| if (from != address(0) && !_isMinBalanceExempt(from)) { | ||
| _validateMinBalance(from); | ||
| } | ||
|
|
||
| if (to != address(0) && !_isMinBalanceExempt(to)) { | ||
| _validateMinBalance(to); | ||
| } | ||
|
|
||
| super._afterTokenTransfer(from, to, amount); | ||
| } | ||
|
|
||
| /** | ||
| * @dev returns the role holder of which is exempt from min balance checks | ||
| */ | ||
| function _minBalanceExemptRole() internal view virtual returns (bytes32); | ||
|
|
||
| /** | ||
| * @dev checks if a user is exempt from min balance checks | ||
| * @param user address of the user | ||
| * @return bool true if the user is exempt from min balance checks | ||
| */ | ||
| function _isMinBalanceExempt(address user) private view returns (bool) { | ||
| return accessControl.hasRole(_minBalanceExemptRole(), user); | ||
| } | ||
|
|
||
| /** | ||
| * @dev validates the minimum balance of a user | ||
| * @param user address of the user | ||
| */ | ||
| function _validateMinBalance(address user) private view { | ||
| uint256 balance = balanceOf(user); | ||
| require( | ||
| balance == 0 || balance >= 1 ether, | ||
| "MTMB: min balance not met" | ||
| ); | ||
| } | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,41 @@ | ||
| // SPDX-License-Identifier: MIT | ||
| pragma solidity 0.8.9; | ||
|
|
||
| import "./mTokenPermissioned.sol"; | ||
| import "./mTokenMinBalance.sol"; | ||
|
|
||
| /** | ||
| * @title mTokenPermissionedMinBalance | ||
| * @notice mToken with permissioned transfers and minimum balance checks | ||
| * @author RedDuck Software | ||
| */ | ||
| //solhint-disable contract-name-camelcase | ||
| abstract contract mTokenPermissionedMinBalance is | ||
| mTokenMinBalance, | ||
| mTokenPermissioned | ||
| { | ||
| // no gap as we would upgrade some of the deployments | ||
| // to mTokenMinBalance | ||
|
|
||
| /** | ||
| * @dev overrides _beforeTokenTransfer function to call the parent hooks | ||
| */ | ||
| function _beforeTokenTransfer( | ||
| address from, | ||
| address to, | ||
| uint256 amount | ||
| ) internal virtual override(mTokenPermissioned, mToken) { | ||
| mTokenPermissioned._beforeTokenTransfer(from, to, amount); | ||
| } | ||
|
|
||
| /** | ||
| * @dev overrides _afterTokenTransfer function to call the parent hooks | ||
| */ | ||
| function _afterTokenTransfer( | ||
|
Comment on lines
+31
to
+34
There was a problem hiding this comment. The docstring/comment for "_afterTokenTransfer" incorrectly states that it overrides "_beforeTokenTransfer". This is a copy-paste typo from the function above it. |
||
| address from, | ||
| address to, | ||
| uint256 amount | ||
| ) internal virtual override(mTokenMinBalance, ERC20Upgradeable) { | ||
| mTokenMinBalance._afterTokenTransfer(from, to, amount); | ||
| } | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,28 @@ | ||
| // SPDX-License-Identifier: MIT | ||
| pragma solidity 0.8.9; | ||
|
|
||
| import "../../feeds/CustomAggregatorV3CompatibleFeed.sol"; | ||
| import "./MGloEuroMidasAccessControlRoles.sol"; | ||
|
|
||
| /** | ||
| * @title MGloEuroCustomAggregatorFeed | ||
| * @notice AggregatorV3 compatible feed for mGLOeuro, | ||
| * where price is submitted manually by feed admins | ||
| * @author RedDuck Software | ||
| */ | ||
| contract MGloEuroCustomAggregatorFeed is | ||
| CustomAggregatorV3CompatibleFeed, | ||
| MGloEuroMidasAccessControlRoles | ||
| { | ||
| /** | ||
| * @dev leaving a storage gap for futures updates | ||
| */ | ||
| uint256[50] private __gap; | ||
|
|
||
| /** | ||
| * @inheritdoc CustomAggregatorV3CompatibleFeed | ||
| */ | ||
| function feedAdminRole() public pure override returns (bytes32) { | ||
| return M_GLO_EURO_CUSTOM_AGGREGATOR_FEED_ADMIN_ROLE; | ||
| } | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,24 @@ | ||
| // SPDX-License-Identifier: MIT | ||
| pragma solidity 0.8.9; | ||
|
|
||
| import "../../feeds/DataFeed.sol"; | ||
| import "./MGloEuroMidasAccessControlRoles.sol"; | ||
|
|
||
| /** | ||
| * @title MGloEuroDataFeed | ||
| * @notice DataFeed for mGLOeuro product | ||
| * @author RedDuck Software | ||
| */ | ||
| contract MGloEuroDataFeed is DataFeed, MGloEuroMidasAccessControlRoles { | ||
| /** | ||
| * @dev leaving a storage gap for futures updates | ||
| */ | ||
| uint256[50] private __gap; | ||
|
|
||
| /** | ||
| * @inheritdoc DataFeed | ||
| */ | ||
| function feedAdminRole() public pure override returns (bytes32) { | ||
| return M_GLO_EURO_CUSTOM_AGGREGATOR_FEED_ADMIN_ROLE; | ||
| } | ||
| } |
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hardcoding "1 ether" (which is "10**18") as the minimum balance assumes that all tokens using this contract will have 18 decimals and require exactly a 1-token minimum balance. If a token has fewer decimals (e.g., 6 decimals for USDC-pegged tokens or 8 decimals for BTC-pegged tokens), "1 ether" translates to an extremely large minimum balance (e.g., "10^12" or "10^10" tokens), making the token practically unusable.
To support tokens with different decimals and allow customization of the minimum balance, consider defining a virtual function "_minBalance()" that defaults to "10 ** decimals()" (or a customizable value) and can be overridden by specific token implementations.