ProtocolTokenCommon

Git Source

Inherits: AppAdministratorOnly, IApplicationEvents, IZeroAddressError, IOwnershipErrors, IIntegrationEvents

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

This contract contains common variables and functions for all Protocol Tokens

State Variables

newAppManagerAddress

address newAppManagerAddress;

appManagerAddress

address appManagerAddress;

handlerAddress

address public handlerAddress;

appManager

IAppManager appManager;

Functions

proposeAppManagerAddress

This function proposes a new appManagerAddress that is put in storage to be confirmed in a separate process

function proposeAppManagerAddress(address _newAppManagerAddress) external appAdministratorOnly(appManagerAddress);

Parameters

Name	Type	Description
_newAppManagerAddress	address	the new address being proposed

confirmAppManagerAddress

This function confirms a new appManagerAddress that was put in storage. It can only be confirmed by the proposed address

function confirmAppManagerAddress() external;

getAppManagerAddress

Function to get the appManagerAddress

AppAdministratorOnly modifier uses appManagerAddress. Only Addresses asigned as AppAdministrator can call function.

function getAppManagerAddress() external view returns (address);

getHandlerAddress

This function returns the handler address

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

Returns

Name	Type	Description
<none>	address	handlerAddress

connectHandlerToToken

This function does not check for zero address. Zero address is a valid address for this function’s purpose.

Function to connect Token to previously deployed Handler contract

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

Parameters

Name	Type	Description
_deployedHandlerAddress	address	address of the currently deployed Handler Address