Git Source

Inherits: RuleAdministratorOnly, ActionTypesArray, ITokenHandlerEvents, IAssetHandlerErrors

Author: @ShaneDuncan602 @oscarsernarosero @TJ-Everett

Setters and getters for the rule in the handler. Meant to be inherited by a handler facet to easily support the rule.

​
Functions

​
getTokenMaxSupplyVolatilityId

Rule Setters and Getters

Retrieve the token max supply volatility rule id

function getTokenMaxSupplyVolatilityId(ActionTypes _action) external view returns (uint32);

Parameters

NameTypeDescription
_actionActionTypesthe action type(this left in to keep signatures the same for dependent apis)

Returns

NameTypeDescription
<none>uint32totalTokenMaxSupplyVolatilityId rule id

​
setTokenMaxSupplyVolatilityId

that setting a rule will automatically activate it.

Set the TokenMaxSupplyVolatility. Restricted to rule administrators only.

function setTokenMaxSupplyVolatilityId(ActionTypes[] calldata _actions, uint32 _ruleId)
    external
    ruleAdministratorOnly(lib.handlerBaseStorage().appManager);

Parameters

NameTypeDescription
_actionsActionTypes[]the action types
_ruleIduint32Rule Id to set

​
setTokenMaxSupplyVolatilityIdFull

that setting a rule will automatically activate it.

Set the setAccountMinMaxTokenBalanceRule suite. Restricted to rule administrators only.

function setTokenMaxSupplyVolatilityIdFull(ActionTypes[] calldata _actions, uint32 _ruleId)
    external
    ruleAdministratorOnly(lib.handlerBaseStorage().appManager);

Parameters

NameTypeDescription
_actionsActionTypes[]actions to have the rule applied to
_ruleIduint32Rule Id corresponding to the actions

​
clearTokenMaxSupplyVolatility

Clear the rule data structure

function clearTokenMaxSupplyVolatility() internal;

​
clearTokenMaxSupplyVolatilityAccumulators

Clear the rule data accumulators

function clearTokenMaxSupplyVolatilityAccumulators() internal;

​
setTokenMaxSupplyVolatilityIdUpdate

that setting a rule will automatically activate it.

Set the TokenMaxSupplyVolatility.

function setTokenMaxSupplyVolatilityIdUpdate(ActionTypes _action, uint32 _ruleId) internal;

Parameters

NameTypeDescription
_actionActionTypesthe action type to set the rule
_ruleIduint32Rule Id to set

​
activateTokenMaxSupplyVolatility

Tells you if the Token Max Supply Volatility rule is active or not.

function activateTokenMaxSupplyVolatility(ActionTypes[] calldata _actions, bool _on)
    external
    ruleAdministratorOnly(lib.handlerBaseStorage().appManager);

Parameters

NameTypeDescription
_actionsActionTypes[]the action type
_onboolboolean representing if the rule is active

​
isTokenMaxSupplyVolatilityActive

Tells you if the Token Max Supply Volatility is active or not.

function isTokenMaxSupplyVolatilityActive(ActionTypes _action) public view returns (bool);

Parameters

NameTypeDescription
_actionActionTypesthe action type

Returns

NameTypeDescription
<none>boolboolean representing if the rule is active
FeesHandlerAccountMinMaxTokenBalance