HandlerTokenMinTxSize

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

setTokenMinTxSizeId

Rule Setters and Getters

that setting a rule will automatically activate it.

Set the TokenMinTxSize. Restricted to rule administrators only.

function setTokenMinTxSizeId(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

setTokenMinTxSizeIdFull

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 setTokenMinTxSizeRule suite. Restricted to rule administrators only.

function setTokenMinTxSizeIdFull(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

clearTokenMinTxSize

Clear the rule data structure

function clearTokenMinTxSize() internal;

setTokenMinTxSizeIdUpdate

that setting a rule will automatically activate it.

Set the TokenMinTxSize.

function setTokenMinTxSizeIdUpdate(ActionTypes _action, uint32 _ruleId) internal;

Parameters

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

activateTokenMinTxSize

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

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

Parameters

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

getTokenMinTxSizeId

Retrieve the tokenMinTxSizeRuleId

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

Parameters

Name	Type	Description
_action	ActionTypes	the action type

Returns

Name	Type	Description
<none>	uint32	tokenMinTransactionRuleId

isTokenMinTxSizeActive

Tells you if the TokenMinTxSizeRule is active or not.

function isTokenMinTxSizeActive(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