HandlerTokenMaxTradingVolume

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

getTokenMaxTradingVolumeId

Rule Setters and Getters

Retrieve the token max trading volume rule id

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

Parameters

Name	Type	Description
_action	ActionTypes	the action type(this left in to keep signatures the same for dependent apis)

Returns

Name	Type	Description
<none>	uint32	tokenMaxTradingVolumeRuleId rule id

setTokenMaxTradingVolumeId

that setting a rule will automatically activate it.

Set the TokenMaxTradingVolume. Restricted to rule administrators only.

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

setTokenMaxTradingVolumeIdFull

that setting a rule will automatically activate it.

Set the setAccountMinMaxTokenBalanceRule suite. Restricted to rule administrators only.

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

Parameters

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

clearTokenMaxTradingVolume

Clear the rule data structure

function clearTokenMaxTradingVolume() internal;

clearTokenMaxTradingVolumeAccumulators

Clear the rule data accumulators

function clearTokenMaxTradingVolumeAccumulators() internal;

clearTokenMaxTradingVolumeSingleAction

Clear the rule data structure

function clearTokenMaxTradingVolumeSingleAction(ActionTypes _action) internal;

setTokenMaxTradingVolumeIdUpdate

that setting a rule will automatically activate it.

Set the TokenMaxTradingVolume.

function setTokenMaxTradingVolumeIdUpdate(ActionTypes _action, uint32 _ruleId) internal;

Parameters

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

activateTokenMaxTradingVolume

Tells you if the token max trading volume rule is active or not.

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

Parameters

Name	Type	Description
_actions	ActionTypes[]	the action type
_on	bool	boolean representing if the rule is active

isTokenMaxTradingVolumeActive

Tells you if the token max trading volume rule is active or not.

function isTokenMaxTradingVolumeActive(ActionTypes _action) public 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