ERC20FreezeableUpgradable

Inherits: Initializable, ERC20Upgradeable

State Variables

bytes32 private constant FREEZEABLE_STORAGE_LOC =
    0xe66b3d99be4f71ea7aa9cf2bc9a8a4827bbe4f718fcfa5d183e05f8945211500

function _getFreezeableStorage() private pure returns (FreezeableStorage storage $);

Allows for checking if an address is frozen

function isFrozen(address target) public view returns (bool);

Parameters

Name	Type	Description
`target`	`address`	The address to check

Returns

Name	Type	Description
`<none>`	`bool`	bool True if the address is frozen

Freezes an address, stopping transfers to or from the address

Emits Frozen(target)

Reverts with ZeroAddress if target is address(0)

Note: Frozen addresses cannot burn tokens as burning involves transferring to address(0)

function _freeze(address target) internal virtual;

Parameters

Name	Type	Description
`target`	`address`	The address to freeze

Unfreezes an address, allowing transfers to or from the address

Emits Unfrozen(target)

function _unfreeze(address target) internal virtual;

Parameters

Name	Type	Description
`target`	`address`	The address to unfreeze

Overrides the default ERC20 _update to enforce freezing

Note: This prevents frozen addresses from burning tokens (burning = transfer to address(0))

Note: This prevents minting to frozen addresses (minting = transfer from address(0))

function _update(address from, address to, uint256 value) internal virtual override;

Emitted when an address is frozen.

event Frozen(address target);

Emitted when an address is unfrozen.

event Unfrozen(address target);

The transfer failed because the address transferring from is frozen.

error FromFrozen();

The transfer failed because the address transferring to is frozen.

error ToFrozen();

Cannot freeze the zero address.

error ZeroAddress();

Note: storage-location: erc7201:apyx.storage.Freezeable

struct FreezeableStorage {
    mapping(address => bool) _frozen;
}