RuleStoragePositionLib - Forte Rules Engine

Reference

Forte Rules Engine Reference v2.1.0
Example
Protocol
- Contents
- Diamond
- Economic
  - Contents
  - IRuleProcessor.sol
  - AppAdministratorOnlyU.sol
  - AppAdministratorOrOwnerOnly.sol
  - RuleAdministratorOnly.sol
  - Rule Processor
    - Contents
    - RuleDataFacet.sol
    - RuleDataInterfaces.sol
    - RuleProcessorDiamondLib.sol
    - TaggedRuleDataFacet.sol
    - ApplicationRiskProcessorFacet.sol
    - RuleApplicationValidationFacet.sol
    - RuleProcessorDiamond.sol
    - ERC20TaggedRuleProcessorFacet.sol
    - ERC721TaggedRuleProcessorFacet.sol
    - ApplicationAccessLevelProcessorFacet.sol
    - RuleCodeData.sol
    - ERC721RuleProcessorFacet.sol
    - RuleProcessorDiamondImports.sol
    - IRuleStorage.sol
    - ApplicationPauseProcessorFacet.sol
    - ERC20RuleProcessorFacet.sol
    - AppRuleDataFacet.sol
    - RuleProcessorCommonLib.sol
    - RuleStoragePositionLib.sol
      - RuleStoragePositionLib
  - AppAdministratorOnly.sol
Common
Client

Author: @ShaneDuncan602 @oscarsernarosero @TJ-Everett

Library for Rules

This contract serves as the storage library for the rules Diamond. It basically serves up the storage position for all rules

State Variables

DIAMOND_CUT_STORAGE_POSITION

bytes32 constant DIAMOND_CUT_STORAGE_POSITION = bytes32(uint256(keccak256("diamond-cut.storage")) - 1);

ACCOUNT_MAX_TRADE_SIZE

every rule has its own storage

bytes32 constant ACCOUNT_MAX_TRADE_SIZE = bytes32(uint256(keccak256("account-max-trade-volume")) - 1);

ACCOUNT_MAX_BUY_SELL_VOLUME_POSITION

bytes32 constant ACCOUNT_MAX_BUY_SELL_VOLUME_POSITION = bytes32(uint256(keccak256("account-max-buy-sell-volume")) - 1);

BUY_FEE_BY_TOKEN_MAX_TRADING_VOLUME_POSITION

bytes32 constant BUY_FEE_BY_TOKEN_MAX_TRADING_VOLUME_POSITION = bytes32(uint256(keccak256("amm.fee-by-volume")) - 1);

TOKEN_MAX_PRICE_VOLATILITY_POSITION

bytes32 constant TOKEN_MAX_PRICE_VOLATILITY_POSITION = bytes32(uint256(keccak256("token-max-price-volatility")) - 1);

TOKEN_MAX_TRADING_VOLUME_POSITION

bytes32 constant TOKEN_MAX_TRADING_VOLUME_POSITION = bytes32(uint256(keccak256("token-max-trading-volume")) - 1);

TOKEN_MIN_TX_SIZE_POSITION

bytes32 constant TOKEN_MIN_TX_SIZE_POSITION = bytes32(uint256(keccak256("token-min-tx-size")) - 1);

TOKEN_MIN_HOLD_TIME_POSITION

bytes32 constant TOKEN_MIN_HOLD_TIME_POSITION = bytes32(uint256(keccak256("token-min-hold-time")) - 1);

ACCOUNT_MIN_MAX_TOKEN_BALANCE_POSITION

bytes32 constant ACCOUNT_MIN_MAX_TOKEN_BALANCE_POSITION =
    bytes32(uint256(keccak256("account-min-max-token-balance")) - 1);

TOKEN_MAX_SUPPLY_VOLATILITY_POSITION

bytes32 constant TOKEN_MAX_SUPPLY_VOLATILITY_POSITION = bytes32(uint256(keccak256("token-max-supply-volatility")) - 1);

ACC_APPROVE_DENY_ORACLE_POSITION

bytes32 constant ACC_APPROVE_DENY_ORACLE_POSITION = bytes32(uint256(keccak256("account-approve-deny-oracle")) - 1);

ACC_MAX_VALUE_BY_ACCESS_LEVEL_POSITION

bytes32 constant ACC_MAX_VALUE_BY_ACCESS_LEVEL_POSITION =
    bytes32(uint256(keccak256("account-max-value-by-access-level")) - 1);

ACC_MAX_TX_VALUE_BY_RISK_SCORE_POSITION

bytes32 constant ACC_MAX_TX_VALUE_BY_RISK_SCORE_POSITION =
    bytes32(uint256(keccak256("account-max-transaction-value-by-access-level")) - 1);

ACCOUNT_MAX_VALUE_BY_RISK_SCORE_POSITION

bytes32 constant ACCOUNT_MAX_VALUE_BY_RISK_SCORE_POSITION =
    bytes32(uint256(keccak256("account-max-value-by-risk-score")) - 1);

TOKEN_MAX_DAILY_TRADES_POSITION

bytes32 constant TOKEN_MAX_DAILY_TRADES_POSITION = bytes32(uint256(keccak256("token-max-daily-trades")) - 1);

AMM_FEE_RULE_POSITION

bytes32 constant AMM_FEE_RULE_POSITION = bytes32(uint256(keccak256("AMM.fee-rule")) - 1);

ACC_MAX_VALUE_OUT_ACCESS_LEVEL_POSITION

bytes32 constant ACC_MAX_VALUE_OUT_ACCESS_LEVEL_POSITION =
    bytes32(uint256(keccak256("account-max-value-out-by-access-level")) - 1);

ENABLED_ACTIONS

bytes32 constant ENABLED_ACTIONS = bytes32(uint256(keccak256("enabled-actions")) - 1);

Functions

accountMaxTradeSizeStorage

Function to store Trade rules

function accountMaxTradeSizeStorage() internal pure returns (IRuleStorage.AccountMaxTradeSizeS storage ds);

Returns

Name	Type	Description
`ds`	`IRuleStorage.AccountMaxTradeSizeS`	Data Storage of Trade Rule

accountMaxBuySellVolumeStorage

Function to store Account Max Buy Volume rules

function accountMaxBuySellVolumeStorage() internal pure returns (IRuleStorage.TokenMaxBuySellVolumeS storage ds);

Returns

Name	Type	Description
`ds`	`IRuleStorage.TokenMaxBuySellVolumeS`	Data Storage of Account Max Buy Volume Rule

purchaseFeeByVolumeStorage

Function to store Purchase Fee by Volume rules

function purchaseFeeByVolumeStorage() internal pure returns (IRuleStorage.PurchaseFeeByVolRuleS storage ds);

Returns

Name	Type	Description
`ds`	`IRuleStorage.PurchaseFeeByVolRuleS`	Data Storage of Purchase Fee by Volume Rule

tokenMaxPriceVolatilityStorage

Function to store Price Volitility rules

function tokenMaxPriceVolatilityStorage() internal pure returns (IRuleStorage.TokenMaxPriceVolatilityS storage ds);

Returns

Name	Type	Description
`ds`	`IRuleStorage.TokenMaxPriceVolatilityS`	Data Storage of Price Volitility Rule

tokenMaxTradingVolumeStorage

Function to store Max Trading Volume rules

function tokenMaxTradingVolumeStorage() internal pure returns (IRuleStorage.TokenMaxTradingVolumeS storage ds);

Returns

Name	Type	Description
`ds`	`IRuleStorage.TokenMaxTradingVolumeS`	Data Storage of Max Trading Volume Rule

tokenMinTxSizePosition

Function to store Token Min Transaction Size rules

function tokenMinTxSizePosition() internal pure returns (IRuleStorage.TokenMinTxSizeS storage ds);

Returns

Name	Type	Description
`ds`	`IRuleStorage.TokenMinTxSizeS`	Data Storage of Token Min Transaction Size Rule

accountMinMaxTokenBalanceStorage

Function to store Account Min Max Token Balance rules

function accountMinMaxTokenBalanceStorage()
    internal
    pure
    returns (IRuleStorage.AccountMinMaxTokenBalanceS storage ds);

Returns

Name	Type	Description
`ds`	`IRuleStorage.AccountMinMaxTokenBalanceS`	Data Storage of Account Min Max Token Balance Rule

tokenMaxSupplyVolatilityStorage

Function to store Max Supply Volitility rules

function tokenMaxSupplyVolatilityStorage() internal pure returns (IRuleStorage.TokenMaxSupplyVolatilityS storage ds);

Returns

Name	Type	Description
`ds`	`IRuleStorage.TokenMaxSupplyVolatilityS`	Data Storage of Max Supply Volitility Rule

accountApproveDenyOracleStorage

Function to store Oracle rules

function accountApproveDenyOracleStorage() internal pure returns (IRuleStorage.AccountApproveDenyOracleS storage ds);

Returns

Name	Type	Description
`ds`	`IRuleStorage.AccountApproveDenyOracleS`	Data Storage of Oracle Rule

accountMaxValueByAccessLevelStorage

Function to store Account Max Value Access Level rules

function accountMaxValueByAccessLevelStorage()
    internal
    pure
    returns (IRuleStorage.AccountMaxValueByAccessLevelS storage ds);

Returns

Name	Type	Description
`ds`	`IRuleStorage.AccountMaxValueByAccessLevelS`	Data Storage of Account Max Value Access Level Rule

accountMaxTxValueByRiskScoreStorage

Function to store Account Max Tx Value by Risk rules

function accountMaxTxValueByRiskScoreStorage()
    internal
    pure
    returns (IRuleStorage.AccountMaxTxValueByRiskScoreS storage ds);

Returns

Name	Type	Description
`ds`	`IRuleStorage.AccountMaxTxValueByRiskScoreS`	Data Storage of Account Max Tx Value by Risk Rule

tokenMinHoldTimeStorage

Function to store Token Min Hold Time rules

function tokenMinHoldTimeStorage() internal pure returns (IRuleStorage.TokenMinHoldTimeS storage ds);

Returns

Name	Type	Description
`ds`	`IRuleStorage.TokenMinHoldTimeS`	Data Storage of Token Min Hold Time Rule

accountMaxValueByRiskScoreStorage

Function to store Account Max Value By Risk Score rules

function accountMaxValueByRiskScoreStorage()
    internal
    pure
    returns (IRuleStorage.AccountMaxValueByRiskScoreS storage ds);

Returns

Name	Type	Description
`ds`	`IRuleStorage.AccountMaxValueByRiskScoreS`	Data Storage of Account Max Value By Risk Score Rule

TokenMaxDailyTradesStorage

Function to store Token Max Daily Trades rules

function TokenMaxDailyTradesStorage() internal pure returns (IRuleStorage.TokenMaxDailyTradesS storage ds);

Returns

Name	Type	Description
`ds`	`IRuleStorage.TokenMaxDailyTradesS`	Data Storage of Token Max Daily Trades rule

ammFeeRuleStorage

Function to store AMM Fee rules

function ammFeeRuleStorage() internal pure returns (IRuleStorage.AMMFeeRuleS storage ds);

Returns

Name	Type	Description
`ds`	`IRuleStorage.AMMFeeRuleS`	Data Storage of AMM Fee rule

accountMaxValueOutByAccessLevelStorage

Function to store Account Max Value Out By Access Level rules

function accountMaxValueOutByAccessLevelStorage()
    internal
    pure
    returns (IRuleStorage.AccountMaxValueOutByAccessLevelS storage ds);

Returns

Name	Type	Description
`ds`	`IRuleStorage.AccountMaxValueOutByAccessLevelS`	Data Storage of Account Max Value Out By Access Level rule

enabledActions

Function to access storage for EnabledActions

function enabledActions() internal pure returns (IRuleStorage.EnabledActions storage ds);

Returns

Name	Type	Description
`ds`	`IRuleStorage.EnabledActions`	Data Storage for RuleApplicationValidationFacet - EnabledActions

RuleProcessorCommonLib AppAdministratorOnly

On this page

State Variables
DIAMOND_CUT_STORAGE_POSITION
ACCOUNT_MAX_TRADE_SIZE
ACCOUNT_MAX_BUY_SELL_VOLUME_POSITION
BUY_FEE_BY_TOKEN_MAX_TRADING_VOLUME_POSITION
TOKEN_MAX_PRICE_VOLATILITY_POSITION
TOKEN_MAX_TRADING_VOLUME_POSITION
TOKEN_MIN_TX_SIZE_POSITION
TOKEN_MIN_HOLD_TIME_POSITION
ACCOUNT_MIN_MAX_TOKEN_BALANCE_POSITION
TOKEN_MAX_SUPPLY_VOLATILITY_POSITION
ACC_APPROVE_DENY_ORACLE_POSITION
ACC_MAX_VALUE_BY_ACCESS_LEVEL_POSITION
ACC_MAX_TX_VALUE_BY_RISK_SCORE_POSITION
ACCOUNT_MAX_VALUE_BY_RISK_SCORE_POSITION
TOKEN_MAX_DAILY_TRADES_POSITION
AMM_FEE_RULE_POSITION
ACC_MAX_VALUE_OUT_ACCESS_LEVEL_POSITION
ENABLED_ACTIONS
Functions
accountMaxTradeSizeStorage
accountMaxBuySellVolumeStorage
purchaseFeeByVolumeStorage
tokenMaxPriceVolatilityStorage
tokenMaxTradingVolumeStorage
tokenMinTxSizePosition
accountMinMaxTokenBalanceStorage
tokenMaxSupplyVolatilityStorage
accountApproveDenyOracleStorage
accountMaxValueByAccessLevelStorage
accountMaxTxValueByRiskScoreStorage
tokenMinHoldTimeStorage
accountMaxValueByRiskScoreStorage
TokenMaxDailyTradesStorage
ammFeeRuleStorage
accountMaxValueOutByAccessLevelStorage
enabledActions

Reference

​State Variables

​DIAMOND_CUT_STORAGE_POSITION

​ACCOUNT_MAX_TRADE_SIZE

​ACCOUNT_MAX_BUY_SELL_VOLUME_POSITION

​BUY_FEE_BY_TOKEN_MAX_TRADING_VOLUME_POSITION

​TOKEN_MAX_PRICE_VOLATILITY_POSITION

​TOKEN_MAX_TRADING_VOLUME_POSITION

​TOKEN_MIN_TX_SIZE_POSITION

​TOKEN_MIN_HOLD_TIME_POSITION

​ACCOUNT_MIN_MAX_TOKEN_BALANCE_POSITION

​TOKEN_MAX_SUPPLY_VOLATILITY_POSITION

​ACC_APPROVE_DENY_ORACLE_POSITION

​ACC_MAX_VALUE_BY_ACCESS_LEVEL_POSITION

​ACC_MAX_TX_VALUE_BY_RISK_SCORE_POSITION

​ACCOUNT_MAX_VALUE_BY_RISK_SCORE_POSITION

​TOKEN_MAX_DAILY_TRADES_POSITION

​AMM_FEE_RULE_POSITION

​ACC_MAX_VALUE_OUT_ACCESS_LEVEL_POSITION

​ENABLED_ACTIONS

​Functions

​accountMaxTradeSizeStorage

​accountMaxBuySellVolumeStorage

​purchaseFeeByVolumeStorage

​tokenMaxPriceVolatilityStorage

​tokenMaxTradingVolumeStorage

​tokenMinTxSizePosition

​accountMinMaxTokenBalanceStorage

​tokenMaxSupplyVolatilityStorage

​accountApproveDenyOracleStorage

​accountMaxValueByAccessLevelStorage

​accountMaxTxValueByRiskScoreStorage

​tokenMinHoldTimeStorage

​accountMaxValueByRiskScoreStorage

​TokenMaxDailyTradesStorage

​ammFeeRuleStorage

​accountMaxValueOutByAccessLevelStorage

​enabledActions

State Variables

DIAMOND_CUT_STORAGE_POSITION

ACCOUNT_MAX_TRADE_SIZE

ACCOUNT_MAX_BUY_SELL_VOLUME_POSITION

BUY_FEE_BY_TOKEN_MAX_TRADING_VOLUME_POSITION

TOKEN_MAX_PRICE_VOLATILITY_POSITION

TOKEN_MAX_TRADING_VOLUME_POSITION

TOKEN_MIN_TX_SIZE_POSITION

TOKEN_MIN_HOLD_TIME_POSITION

ACCOUNT_MIN_MAX_TOKEN_BALANCE_POSITION

TOKEN_MAX_SUPPLY_VOLATILITY_POSITION

ACC_APPROVE_DENY_ORACLE_POSITION

ACC_MAX_VALUE_BY_ACCESS_LEVEL_POSITION

ACC_MAX_TX_VALUE_BY_RISK_SCORE_POSITION

ACCOUNT_MAX_VALUE_BY_RISK_SCORE_POSITION

TOKEN_MAX_DAILY_TRADES_POSITION

AMM_FEE_RULE_POSITION

ACC_MAX_VALUE_OUT_ACCESS_LEVEL_POSITION

ENABLED_ACTIONS

Functions

accountMaxTradeSizeStorage

accountMaxBuySellVolumeStorage

purchaseFeeByVolumeStorage

tokenMaxPriceVolatilityStorage

tokenMaxTradingVolumeStorage

tokenMinTxSizePosition

accountMinMaxTokenBalanceStorage

tokenMaxSupplyVolatilityStorage

accountApproveDenyOracleStorage

accountMaxValueByAccessLevelStorage

accountMaxTxValueByRiskScoreStorage

tokenMinHoldTimeStorage

accountMaxValueByRiskScoreStorage

TokenMaxDailyTradesStorage

ammFeeRuleStorage

accountMaxValueOutByAccessLevelStorage

enabledActions