FacetsCommonImports

Forte Rules Engine

GitHub FRE

Contributor Guide

GitHub SDK

Reference

SDK Reference

Guides

Contact Us

Introduction

See the Rules Engine in action in minutes

Quickstart

Supported Networks for the Forte Rules Engine v2

Networks

Top-level containers that define which rules to run and when. All logic lives inside a policy.

Policies

Rules evaluate conditional expressions and trigger effects based on the outcome.

Rules

Persistent, on-chain values that store data used across rules.

Trackers

Smart contracts that subscribe to Forte Rules Engine policies

Calling Contracts

Connect your policy to external contracts for data lookups or on-chain actions.

Foreign Contracts

How to add the Rules Engine to your existing project

Integrate

Integrate With Your Project

Bringing off-chain data on-chain to power rules

O2 Oracle API

Understanding the syntax for defining policies

Policy Syntax

Reference ToC

RulesEngine

connectConfig

generateModifier

getConfig

injectModifier

policyModifierGeneration

setupConfig

matchArray

operandArray

supportedTrackerTypes

truMatchArray

foreignCallJSON

PolicyJSON

ruleJSON

FCNameToID

ForeignCallArgumentMappings

ForeignCallDefinition

FunctionArgument

hexToFunctionSignature

IndividualArugmentMapping

PlaceholderStruct

RawData

RulesEngineComponentContract

RulesEnginePolicyContract

RuleStorageSet

RuleStruct

stringReplacement

TrackerDefinition

trackerIndexNameMapping

EffectType

pTypeEnum

Best in class tooling for token economies and compliance management

See the Forte Rules Engine in action with a demo application

Live Demo

Deployment directory for protocol supported chains

High level overview of the Forte Rules Engine

Overview

Enables pausing all mint, burn, buy, sell, and transfer actions of an application

Pause

Enforces accumulated balance limits for user accounts based on a risk score

Account Max Value By Risk

Account Max Value By Risk Score

Enforces accumulated balance limits for user accounts based on access level

Account Max Value By Access

Account Max Value By Access Level

Enforces limits on value transferred out of economy based on access level

Account Max Value Out

Account Max Value Out By Access Level

Account Max Received By Access Level

Account Deny For No Access Level Rule

Enforces `to` and/or `from` side of transactions

Account Approve/Deny Oracle

Enforce token balance thresholds for user accounts

Account Min/Max Balance

Account Min/Max Token Balance

Restrict user account trade size based on account tags

Account Max Trade Size

Account Max Tx Value

Account Max Transaction Value By Risk Score

Token Max Trading Volume

Token Max Buy Sell Volume Rule

Token Max Supply Volatility

Token Max Daily Trades

Token Min Hold Time

Token Min Tx Size

App Administrator Roles

Administrator Configuration

Customization Options

Tags Guide

Tagged Rules

Protocol Structure

Access Level Guide

Access Level Rules

External Provider

Risk Score Guide

Risk Score Rules

Action Types

Oracle Guide

Oracle Rules

External Oracle

Oracle Configuration

Pricing Guide

Third-Party Solutions

NFT Pricing

Pricing Module Deployment

Glossary

Fee Guide

Transfer Fee

Understand how these guides are organized to help you get launched fast

How to Use the Guides

How to use the Forte Rules Engine in your project

Installation Guide

How to setup and deploy your token contracts

How to deploy an ERC-20 Token that hooks into the Forte Rules Engine

Deploy ERC-20 Token

How to deploy an ERC-721 NFT contract that hooks into the Forte Rules Engine

Deploy ERC-721 Token

How to setup and deploy your client contracts

Understanding the required environment variables

Environment Variables

Environment Variable Configuration

Deploy App Manager

Deploy Application Manager

Deploy Token Handlers

Explanations of how to create and configure various rules

Setting token lockup timeframes based on NFT possession

Airdrop Lockup

Protocol Deployment

How to submit code changes for inclusion in the protocol

Checkout Repository

Submodule Upgrade

Reference documentation for the Forte Rules Engine