HandlerAccountMinMaxTokenBalance

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

setAccountMinMaxTokenBalanceId

Rule Setters and Getters

that setting a rule will automatically activate it.

Set the accountMinMaxTokenBalanceRuleId. Restricted to rule administrators only.

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

Parameters

Name	Type	Description
_actions	ActionTypes[]	the action types
_ruleId	uint32	Rule Id to set

setAccountMinMaxTokenBalanceIdFull

that setting a rule will automatically activate it.

This function does not check that the array length is greater than zero to allow for clearing out of the action types data

Set the setAccountMinMaxTokenBalanceRule suite. Restricted to rule administrators only.

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

Parameters

Name	Type	Description
_actions	ActionTypes[]	actions to have the rule applied to
_ruleIds	uint32[]	Rule Id corresponding to the actions

clearMinMaxTokenBalance

Clear the rule data structure

function clearMinMaxTokenBalance() internal;

setAccountMinMaxTokenBalanceIdUpdate

that setting a rule will automatically activate it.

Set the AccountMaxMinMaxTokenBalanceRuleId.

function setAccountMinMaxTokenBalanceIdUpdate(ActionTypes _action, uint32 _ruleId) internal;

Parameters

Name	Type	Description
_action	ActionTypes	the action type to set the rule
_ruleId	uint32	Rule Id to set

activateAccountMinMaxTokenBalance

enable/disable rule. Disabling a rule will save gas on transfer transactions.

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

Parameters

Name	Type	Description
_actions	ActionTypes[]	the action types
_on	bool	boolean representing if a rule must be checked or not.

getAccountMinMaxTokenBalanceId

Get the accountMinMaxTokenBalanceRuleId.

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

Parameters

Name	Type	Description
_action	ActionTypes	the action type

Returns

Name	Type	Description
<none>	uint32	accountMinMaxTokenBalance rule id.

isAccountMinMaxTokenBalanceActive

Tells you if the AccountMinMaxTokenBalance is active or not.

function isAccountMinMaxTokenBalanceActive(ActionTypes _action) external view returns (bool);

Parameters

Name	Type	Description
_action	ActionTypes	the action type

Returns

Name	Type	Description
<none>	bool	boolean representing if the rule is active