Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

📒 Exclude tokens in blacklisted accounts from total supply #1220

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions packages/contracts-por/contracts/TrueCurrency.sol
Original file line number Diff line number Diff line change
Expand Up @@ -86,6 +86,13 @@ abstract contract TrueCurrency is BurnableTokenWithBounds {
*/
function setBlacklisted(address account, bool _isBlacklisted) external override onlyOwner {
require(uint256(account) >= REDEMPTION_ADDRESS_COUNT, "TrueCurrency: blacklisting of redemption address is not allowed");
require(isBlacklisted[account] != _isBlacklisted, "TrueCurrency: blacklisted status would not change");

if (_isBlacklisted) {
blacklistedAmount += _balances[account];
} else {
blacklistedAmount -= _balances[account];
}
isBlacklisted[account] = _isBlacklisted;
emit Blacklisted(account, _isBlacklisted);
}
Expand Down
2 changes: 1 addition & 1 deletion packages/contracts-por/contracts/common/ERC20.sol
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,7 @@ abstract contract ERC20 is ClaimableOwnable, Context, IERC20 {
* @dev See {IERC20-totalSupply}.
*/
function totalSupply() public view virtual override returns (uint256) {
return _totalSupply;
return _totalSupply - blacklistedAmount;
}

/**
Expand Down
3 changes: 3 additions & 0 deletions packages/contracts-por/contracts/common/ProxyStorage.sol
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,9 @@ contract ProxyStorage {
address public chainReserveFeed;
bool public proofOfReserveEnabled;

// Blacklisted accounts are excluded from total supply until they are un-blacklisted.
uint256 public blacklistedAmount;

/* Additionally, we have several keccak-based storage locations.
* If you add more keccak-based storage mappings, such as mappings, you must document them here.
* If the length of the keccak input is the same as an existing mapping, it is possible there could be a preimage collision.
Expand Down
11 changes: 11 additions & 0 deletions packages/contracts-por/test/TokenController.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -589,10 +589,21 @@ describe('TokenController', () => {

describe('setBlacklisted', () => {
it('sets blacklisted status for the account', async () => {
await token.connect(thirdWallet).transfer(otherWallet.address, parseEther('10'))

const initialTotalSupply = await token.totalSupply()

await expect(controller.setBlacklisted(otherWallet.address, true)).to.emit(token, 'Blacklisted')
.withArgs(otherWallet.address, true)

const reducedTotalSupply = await token.totalSupply()
expect(reducedTotalSupply === initialTotalSupply - await token.balanceOf(otherWallet.address))

await expect(controller.setBlacklisted(otherWallet.address, false)).to.emit(token, 'Blacklisted')
.withArgs(otherWallet.address, false)

const increasedTotalSupply = await token.totalSupply()
expect(increasedTotalSupply === initialTotalSupply)
})

it('rejects when called by non owner', async () => {
Expand Down