Skip to main content

OverlayerWrap

The stable coin Overlayer

blacklistActivationTime​

uint256 blacklistActivationTime

The timestamp of the last blacklist activation request

BLACKLIST_ACTIVATION_TIME​

uint256 BLACKLIST_ACTIVATION_TIME

Time delay for blacklisting to be activated

notDisabled​

modifier notDisabled(address account_)

Ensure account is not blacklisted

blacklistAllowed​

modifier blacklistAllowed()

Ensure blacklisting is allowed

constructor​

constructor(struct IOverlayerWrapDefs.ConstructorParams params_) public

Constructor initializes the OverlayerWrap token

Parameters​

NameTypeDescription
params_struct IOverlayerWrapDefs.ConstructorParamsA struct containing: - admin: Address of the contract administrator - name: Token name - symbol: Token symbol - collateral: Configuration for the main collateral token - aCollateral: Configuration for the associated collateral token - maxMintPerBlock: Maximum amount that can be minted per block - maxRedeemPerBlock: Maximum amount that can be redeemed per block

mint​

function mint(struct OverlayerWrapCoreTypes.Order order_) external

Mint tokens

Can be disabled by the gatekeeper via disableMint()

Parameters​

NameTypeDescription
order_struct OverlayerWrapCoreTypes.OrderA struct containing the mint order

setBlackListTime​

function setBlackListTime(uint256 time_) external

Sets the blacklist time.

Disables blakclist if time is zero.

Parameters​

NameTypeDescription
time_uint256The timestamp.

redeem​

function redeem(struct OverlayerWrapCoreTypes.Order order_) external

Redeem collateral

Cannot be disabled or paused

Parameters​

NameTypeDescription
order_struct OverlayerWrapCoreTypes.OrderA struct containing the redeem order

disableAccount​

function disableAccount(address account_) external

Disable an account from performing transactions

Parameters​

NameTypeDescription
account_addressThe account to be disabled

enableAccount​

function enableAccount(address account_) external

Enable an account from performing transactions

Parameters​

NameTypeDescription
account_addressThe account to be enabled

renounceRole​

function renounceRole(bytes32 role_, address account_) public

Overrides renounceRole to prevent self-removal of BLACKLISTED_ROLE

All other roles can still be renounced via the inherited behavior

Parameters​

NameTypeDescription
role_bytes32The role to renounce
account_addressThe account renouncing the role (must be msg.sender per AccessControl)

grantRole​

function grantRole(bytes32 role_, address account_) public

Prevents direct grant of BLACKLISTED_ROLE; use disableAccount() instead

Parameters​

NameTypeDescription
role_bytes32The role to grant
account_addressThe account to grant the role to

revokeRole​

function revokeRole(bytes32 role_, address account_) public

Prevents direct revoke of BLACKLISTED_ROLE; use enableAccount() instead

Parameters​

NameTypeDescription
role_bytes32The role to revoke
account_addressThe account to revoke the role from

_update​

function _update(address from_, address to_, uint256 value_) internal

_Transfers a value amount of tokens from from to to, or alternatively mints (or burns) if from (or to) is the zero address. All customizations to transfers, mints, and burns should be done by overriding this function.

Emits a {Transfer} event._