Forte Rules Engine Reference v2.2.x
Reference documentation for the Forte Rules Engine
Forte Rules Engine
This repository contains an EVM-based protocol designed to meet the unique needs of tokenized assets and on-chain economies. The protocol enables the creation and management of economic and compliance controls for your on-chain economy at the token level, allowing for maximum flexibility while maintaining the transparency and trustlessness of Web3.
Installation
To install the package, run the following command in the root of your project:
Dependencies
numbered releases assigned to unmodified upstream binaries.
This package requires the following:
-
Foundry
NOTE: In order to ensure full support, run this command to get the correct Foundry version:
Thrackle maintains a modified
foundryup
tool to provide versioned releases assigned to releases of unmodified upstream
binaries.
-
Scripting Requirements
eth-abi 5.1.0
jq 1.6.0
python-dotenv 1.0.1
These packages can be installed manually or through the following helper command:
-
@openzeppelin/contracts
version 4.9.6 and@openzeppelin/contracts-upgradeable
version 4.9.6.If the contracts show any compiling errors, try to manually update the version of the existing openzeppelin library in your project by doing:
Contributing
Please visit our Contributor Guide.
Licensing
The primary license for Forte Protocol Rules Engine is the Business Source License 1.1 (BUSL-1.1
), see LICENSE. However, some files are dual licensed under GPL-2.0-or-later
:
- All files in
src/example/
may also be licensed underGPL-2.0-or-later
(as indicated in their SPDX headers), see Example LICENSE
Other Exceptions
- All files in
lib/
are licensed underMIT
(as indicated in its SPDX header), see LICENSE_MIT - All files in
src/example/
may also be licensed underGPL-2.0-or-later
(as indicated in their SPDX headers), see Example LICENSE Other Exceptions - All files in
contracts/test
remain unlicensed (as indicated in their SPDX headers).