Git Source

Inherits: Initializable, ERC20Upgradeable, ProtocolTokenCommonU, ReentrancyGuard

Author: @ShaneDuncan602, @oscarsernarosero, @TJ-Everett, @Palmerg4

This is the base contract for all protocol ERC721Upgradeable Minimals.

State Variables

handlerAddress

address public handlerAddress;

handler

IProtocolTokenHandler private handler;

__gap

memory placeholders to allow variable addition without affecting client upgradeability

uint256[49] __gap;

Functions

__ProtocolERC20_init

Initializer sets the the App Manager

function __ProtocolERC20_init(address _appManagerAddress) internal onlyInitializing;

Parameters

NameTypeDescription
_appManagerAddressaddressAddress of App Manager

__ProtocolERC20_init_unchained

function __ProtocolERC20_init_unchained(address _appManagerAddress) internal onlyInitializing;

_beforeTokenTransfer

Function called before any token transfers to confirm transfer is within rules of the protocol

function _beforeTokenTransfer(address from, address to, uint256 amount) internal override;

Parameters

NameTypeDescription
fromaddresssender address
toaddressrecipient address
amountuint256number of tokens to be transferred

getHandlerAddress

Rule Processor Module Check

This function returns the handler address

function getHandlerAddress() external view override returns (address);

Returns

NameTypeDescription
<none>addresshandlerAddress

connectHandlerToToken

Function to connect Token to previously deployed Handler contract

function connectHandlerToToken(address _deployedHandlerAddress)
    external
    override
    appAdministratorOnly(appManagerAddress);

Parameters

NameTypeDescription
_deployedHandlerAddressaddressaddress of the currently deployed Handler Address