HandlerTokenMaxBuySellVolume
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
getTokenMaxBuySellVolumeId
Rule Setters and Getters
Retrieve the Account Max Buy Sell Size Rule Id
Parameters
Name | Type | Description |
---|---|---|
_actions | ActionTypes | the action types |
Returns
Name | Type | Description |
---|---|---|
<none> | uint32 | accountMaxBuySellSizeId |
setTokenMaxBuySellVolumeId
that setting a rule will automatically activate it.
Set the TokenMaxBuySellVolume. Restricted to rule administrators only.
Parameters
Name | Type | Description |
---|---|---|
_actions | ActionTypes[] | the action types |
_ruleId | uint32 | Rule Id to set |
setTokenMaxBuySellVolumeIdFull
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 TokenMaxBuySellVolume suite. Restricted to rule administrators only.
Parameters
Name | Type | Description |
---|---|---|
_actions | ActionTypes[] | actions to have the rule applied to |
_ruleIds | uint32[] | Rule Id corresponding to the actions |
clearTokenMaxBuySellVolume
Clear the rule data structure
clearTokenMaxBuySellVolumeAccumulators
Clear the rule data accumulators
setTokenMaxBuySellVolumeIdUpdate
that setting a rule will automatically activate it.
Set the TokenMaxBuySellVolume.
Parameters
Name | Type | Description |
---|---|---|
_action | ActionTypes | the action type to set the rule |
_ruleId | uint32 | Rule Id to set |
activateTokenMaxBuySellVolume
enable/disable rule. Disabling a rule will save gas on transfer transactions.
Parameters
Name | Type | Description |
---|---|---|
_actions | ActionTypes[] | the action type to set the rule |
_on | bool | boolean representing if a rule must be checked or not. |
isTokenMaxBuySellVolumeActive
Tells you if the Account Max Buy Sell Size Rule is active or not.
Parameters
Name | Type | Description |
---|---|---|
_action | ActionTypes | the action type |
Returns
Name | Type | Description |
---|---|---|
<none> | bool | boolean representing if the rule is active |