// SPDX-License-Identifier: MIT
pragma hyperion >=0.0;
import "./ERC20.hyp";
import "./Ownable.hyp";
/**
* @title CustomERC20
* @notice QRC20 token with configurable supply cap, per-wallet cap, and per-tx cap.
* The owner can mint up to `maxSupply`, adjust caps, and manage the
* cap-bypass whitelist post-deploy. `maxSupply` is immutable.
*/
contract CustomERC20 is ERC20, Ownable {
uint8 private immutable _decimals;
uint256 public immutable maxSupply;
uint256 public maxWalletAmount;
uint256 public maxTxLimit;
mapping(address => bool) private _isExcludedFromLimits;
event MaxWalletAmountUpdated(uint256 previousValue, uint256 newValue);
event MaxTxLimitUpdated(uint256 previousValue, uint256 newValue);
event ExcludedFromLimitsUpdated(address indexed account, bool excluded);
constructor(
string memory name_,
string memory symbol_,
uint256 initialSupply_,
uint8 decimals_,
uint256 maxSupply_,
address recipient_,
address owner_,
uint256 maxWalletAmount_,
uint256 maxTxLimit_
) ERC20(name_, symbol_) Ownable() {
require(bytes(name_).length > 0, "CustomERC20: empty name");
require(bytes(symbol_).length > 0, "CustomERC20: empty symbol");
require(decimals_ <= 18, "CustomERC20: decimals > 18");
require(maxSupply_ > 0, "CustomERC20: maxSupply is zero");
require(initialSupply_ <= maxSupply_, "CustomERC20: initialSupply exceeds maxSupply");
require(owner_ != address(0), "CustomERC20: owner is zero");
require(recipient_ != address(0), "CustomERC20: recipient is zero");
_decimals = decimals_;
maxSupply = maxSupply_;
maxWalletAmount = maxWalletAmount_;
maxTxLimit = maxTxLimit_;
_mint(recipient_, initialSupply_);
_isExcludedFromLimits[recipient_] = true;
emit ExcludedFromLimitsUpdated(recipient_, true);
// transferOwnership will move exclusion from the deploying contract
// (factory / EOA) to owner_ via the _transferOwnership override.
transferOwnership(owner_);
}
function decimals() public view override returns (uint8) {
return _decimals;
}
/**
* @notice Mint `amount` new tokens to `to`. Only callable by the owner.
* Reverts if `totalSupply() + amount > maxSupply`. Uses
* subtraction form to guarantee the revert message fires
* regardless of how the compiler handles arithmetic overflow.
*/
function mint(address to, uint256 amount) external onlyOwner {
require(amount <= maxSupply - totalSupply(), "CustomERC20: exceeds maxSupply");
_mint(to, amount);
}
/**
* @notice Set the per-wallet holding cap. Zero disables the cap.
*/
function setMaxWalletAmount(uint256 newValue) external onlyOwner {
emit MaxWalletAmountUpdated(maxWalletAmount, newValue);
maxWalletAmount = newValue;
}
/**
* @notice Set the per-tx transfer cap. Zero disables the cap.
*/
function setMaxTxLimit(uint256 newValue) external onlyOwner {
emit MaxTxLimitUpdated(maxTxLimit, newValue);
maxTxLimit = newValue;
}
/**
* @notice Add or remove `account` from the cap-bypass whitelist.
* Whitelisted accounts bypass both maxWalletAmount and maxTxLimit
* on both the sender and recipient side.
*/
function setExcludedFromLimits(address account, bool excluded) external onlyOwner {
_isExcludedFromLimits[account] = excluded;
emit ExcludedFromLimitsUpdated(account, excluded);
}
/**
* @notice Returns true if `account` is exempt from per-wallet / per-tx caps.
*/
function isExcludedFromLimits(address account) external view returns (bool) {
return _isExcludedFromLimits[account];
}
/**
* @dev Keeps the cap-bypass whitelist aligned with the owner role across
* ownership handoffs. Renouncing ownership (newOwner == address(0))
* still revokes the old owner's exemption; a follow-up
* setExcludedFromLimits(oldOwner, true) by the new owner can restore
* it if desired.
*/
function _transferOwnership(address newOwner) internal override {
address oldOwner = owner();
if (oldOwner != address(0) && oldOwner != newOwner) {
_isExcludedFromLimits[oldOwner] = false;
emit ExcludedFromLimitsUpdated(oldOwner, false);
}
if (newOwner != address(0) && !_isExcludedFromLimits[newOwner]) {
_isExcludedFromLimits[newOwner] = true;
emit ExcludedFromLimitsUpdated(newOwner, true);
}
super._transferOwnership(newOwner);
}
function transfer(address recipient, uint256 amount) public override returns (bool) {
require(_checkLimits(msg.sender, recipient, amount), "Transfer exceeds limits");
return super.transfer(recipient, amount);
}
function transferFrom(address sender, address recipient, uint256 amount) public override returns (bool) {
require(_checkLimits(sender, recipient, amount), "Transfer exceeds limits");
return super.transferFrom(sender, recipient, amount);
}
function _checkLimits(address sender, address recipient, uint256 amount) internal view returns (bool) {
if (_isExcludedFromLimits[sender] || _isExcludedFromLimits[recipient]) {
return true;
}
if (maxTxLimit > 0 && amount > maxTxLimit) {
return false;
}
if (maxWalletAmount > 0 && balanceOf(recipient) + amount > maxWalletAmount) {
return false;
}
return true;
}
}
// SPDX-License-Identifier: MIT
pragma hyperion >=0.0;
import "./IERC20.hyp";
import "./IERC20Metadata.hyp";
import "./Context.hyp";
/**
* @dev Implementation of the {IERC20} interface.
*
* This implementation is agnostic to the way tokens are created. This means
* that a supply mechanism has to be added in a derived contract using {_mint}.
* For a generic mechanism see {ERC20PresetMinterPauser}.
*
* TIP: For a detailed writeup see our guide
* https://forum.openzeppelin.com/t/how-to-implement-erc20-supply-mechanisms/226[How
* to implement supply mechanisms].
*
* The default value of {decimals} is 18. To change this, you should override
* this function so it returns a different value.
*
* We have followed general OpenZeppelin Contracts guidelines: functions revert
* instead returning `false` on failure. This behavior is nonetheless
* conventional and does not conflict with the expectations of ERC20
* applications.
*
* Additionally, an {Approval} event is emitted on calls to {transferFrom}.
* This allows applications to reconstruct the allowance for all accounts just
* by listening to said events. Other implementations of the EIP may not emit
* these events, as it isn't required by the specification.
*
* Finally, the non-standard {decreaseAllowance} and {increaseAllowance}
* functions have been added to mitigate the well-known issues around setting
* allowances. See {IERC20-approve}.
*/
contract ERC20 is Context, IERC20, IERC20Metadata {
mapping(address => uint256) private _balances;
mapping(address => mapping(address => uint256)) private _allowances;
uint256 private _totalSupply;
string private _name;
string private _symbol;
/**
* @dev Sets the values for {name} and {symbol}.
*
* All two of these values are immutable: they can only be set once during
* construction.
*/
constructor(string memory name_, string memory symbol_) {
_name = name_;
_symbol = symbol_;
}
/**
* @dev Returns the name of the token.
*/
function name() public view virtual override returns (string memory) {
return _name;
}
/**
* @dev Returns the symbol of the token, usually a shorter version of the
* name.
*/
function symbol() public view virtual override returns (string memory) {
return _symbol;
}
/**
* @dev Returns the number of decimals used to get its user representation.
* For example, if `decimals` equals `2`, a balance of `505` tokens should
* be displayed to a user as `5.05` (`505 / 10 ** 2`).
*
* Tokens usually opt for a value of 18, imitating the relationship between
* Ether and Wei. This is the default value returned by this function, unless
* it's overridden.
*
* NOTE: This information is only used for _display_ purposes: it in
* no way affects any of the arithmetic of the contract, including
* {IERC20-balanceOf} and {IERC20-transfer}.
*/
function decimals() public view virtual override returns (uint8) {
return 18;
}
/**
* @dev See {IERC20-totalSupply}.
*/
function totalSupply() public view virtual override returns (uint256) {
return _totalSupply;
}
/**
* @dev See {IERC20-balanceOf}.
*/
function balanceOf(address account) public view virtual override returns (uint256) {
return _balances[account];
}
/**
* @dev See {IERC20-transfer}.
*
* Requirements:
*
* - `to` cannot be the zero address.
* - the caller must have a balance of at least `amount`.
*/
function transfer(address to, uint256 amount) public virtual override returns (bool) {
address owner = _msgSender();
_transfer(owner, to, amount);
return true;
}
/**
* @dev See {IERC20-allowance}.
*/
function allowance(address owner, address spender) public view virtual override returns (uint256) {
return _allowances[owner][spender];
}
/**
* @dev See {IERC20-approve}.
*
* NOTE: If `amount` is the maximum `uint256`, the allowance is not updated on
* `transferFrom`. This is semantically equivalent to an infinite approval.
*
* Requirements:
*
* - `spender` cannot be the zero address.
*/
function approve(address spender, uint256 amount) public virtual override returns (bool) {
address owner = _msgSender();
_approve(owner, spender, amount);
return true;
}
/**
* @dev See {IERC20-transferFrom}.
*
* Emits an {Approval} event indicating the updated allowance. This is not
* required by the EIP. See the note at the beginning of {ERC20}.
*
* NOTE: Does not update the allowance if the current allowance
* is the maximum `uint256`.
*
* Requirements:
*
* - `from` and `to` cannot be the zero address.
* - `from` must have a balance of at least `amount`.
* - the caller must have allowance for ``from``'s tokens of at least
* `amount`.
*/
function transferFrom(address from, address to, uint256 amount) public virtual override returns (bool) {
address spender = _msgSender();
_spendAllowance(from, spender, amount);
_transfer(from, to, amount);
return true;
}
/**
* @dev Atomically increases the allowance granted to `spender` by the caller.
*
* This is an alternative to {approve} that can be used as a mitigation for
* problems described in {IERC20-approve}.
*
* Emits an {Approval} event indicating the updated allowance.
*
* Requirements:
*
* - `spender` cannot be the zero address.
*/
function increaseAllowance(address spender, uint256 addedValue) public virtual returns (bool) {
address owner = _msgSender();
_approve(owner, spender, allowance(owner, spender) + addedValue);
return true;
}
/**
* @dev Atomically decreases the allowance granted to `spender` by the caller.
*
* This is an alternative to {approve} that can be used as a mitigation for
* problems described in {IERC20-approve}.
*
* Emits an {Approval} event indicating the updated allowance.
*
* Requirements:
*
* - `spender` cannot be the zero address.
* - `spender` must have allowance for the caller of at least
* `subtractedValue`.
*/
function decreaseAllowance(address spender, uint256 subtractedValue) public virtual returns (bool) {
address owner = _msgSender();
uint256 currentAllowance = allowance(owner, spender);
require(currentAllowance >= subtractedValue, "ERC20: decreased allowance below zero");
unchecked {
_approve(owner, spender, currentAllowance - subtractedValue);
}
return true;
}
/**
* @dev Moves `amount` of tokens from `from` to `to`.
*
* This internal function is equivalent to {transfer}, and can be used to
* e.g. implement automatic token fees, slashing mechanisms, etc.
*
* Emits a {Transfer} event.
*
* Requirements:
*
* - `from` cannot be the zero address.
* - `to` cannot be the zero address.
* - `from` must have a balance of at least `amount`.
*/
function _transfer(address from, address to, uint256 amount) internal virtual {
require(from != address(0), "ERC20: transfer from the zero address");
require(to != address(0), "ERC20: transfer to the zero address");
_beforeTokenTransfer(from, to, amount);
uint256 fromBalance = _balances[from];
require(fromBalance >= amount, "ERC20: transfer amount exceeds balance");
unchecked {
_balances[from] = fromBalance - amount;
// Overflow not possible: the sum of all balances is capped by totalSupply, and the sum is preserved by
// decrementing then incrementing.
_balances[to] += amount;
}
emit Transfer(from, to, amount);
_afterTokenTransfer(from, to, amount);
}
/** @dev Creates `amount` tokens and assigns them to `account`, increasing
* the total supply.
*
* Emits a {Transfer} event with `from` set to the zero address.
*
* Requirements:
*
* - `account` cannot be the zero address.
*/
function _mint(address account, uint256 amount) internal virtual {
require(account != address(0), "ERC20: mint to the zero address");
_beforeTokenTransfer(address(0), account, amount);
_totalSupply += amount;
unchecked {
// Overflow not possible: balance + amount is at most totalSupply + amount, which is checked above.
_balances[account] += amount;
}
emit Transfer(address(0), account, amount);
_afterTokenTransfer(address(0), account, amount);
}
/**
* @dev Destroys `amount` tokens from `account`, reducing the
* total supply.
*
* Emits a {Transfer} event with `to` set to the zero address.
*
* Requirements:
*
* - `account` cannot be the zero address.
* - `account` must have at least `amount` tokens.
*/
function _burn(address account, uint256 amount) internal virtual {
require(account != address(0), "ERC20: burn from the zero address");
_beforeTokenTransfer(account, address(0), amount);
uint256 accountBalance = _balances[account];
require(accountBalance >= amount, "ERC20: burn amount exceeds balance");
unchecked {
_balances[account] = accountBalance - amount;
// Overflow not possible: amount <= accountBalance <= totalSupply.
_totalSupply -= amount;
}
emit Transfer(account, address(0), amount);
_afterTokenTransfer(account, address(0), amount);
}
/**
* @dev Sets `amount` as the allowance of `spender` over the `owner` s tokens.
*
* This internal function is equivalent to `approve`, and can be used to
* e.g. set automatic allowances for certain subsystems, etc.
*
* Emits an {Approval} event.
*
* Requirements:
*
* - `owner` cannot be the zero address.
* - `spender` cannot be the zero address.
*/
function _approve(address owner, address spender, uint256 amount) internal virtual {
require(owner != address(0), "ERC20: approve from the zero address");
require(spender != address(0), "ERC20: approve to the zero address");
_allowances[owner][spender] = amount;
emit Approval(owner, spender, amount);
}
/**
* @dev Updates `owner` s allowance for `spender` based on spent `amount`.
*
* Does not update the allowance amount in case of infinite allowance.
* Revert if not enough allowance is available.
*
* Might emit an {Approval} event.
*/
function _spendAllowance(address owner, address spender, uint256 amount) internal virtual {
uint256 currentAllowance = allowance(owner, spender);
if (currentAllowance != type(uint256).max) {
require(currentAllowance >= amount, "ERC20: insufficient allowance");
unchecked {
_approve(owner, spender, currentAllowance - amount);
}
}
}
/**
* @dev Hook that is called before any transfer of tokens. This includes
* minting and burning.
*
* Calling conditions:
*
* - when `from` and `to` are both non-zero, `amount` of ``from``'s tokens
* will be transferred to `to`.
* - when `from` is zero, `amount` tokens will be minted for `to`.
* - when `to` is zero, `amount` of ``from``'s tokens will be burned.
* - `from` and `to` are never both zero.
*
* To learn more about hooks, head to xref:ROOT:extending-contracts.adoc#using-hooks[Using Hooks].
*/
function _beforeTokenTransfer(address from, address to, uint256 amount) internal virtual {}
/**
* @dev Hook that is called after any transfer of tokens. This includes
* minting and burning.
*
* Calling conditions:
*
* - when `from` and `to` are both non-zero, `amount` of ``from``'s tokens
* has been transferred to `to`.
* - when `from` is zero, `amount` tokens have been minted for `to`.
* - when `to` is zero, `amount` of ``from``'s tokens have been burned.
* - `from` and `to` are never both zero.
*
* To learn more about hooks, head to xref:ROOT:extending-contracts.adoc#using-hooks[Using Hooks].
*/
function _afterTokenTransfer(address from, address to, uint256 amount) internal virtual {}
}