This QuickStart will guide you through using the Forte Rules Engine in a local anvil development environment utilizing the Forte Rules Engine SDK. Following this guide, you will walk through the entire Forte Rules Engine workflow:
Set up your environment
Create a policy
Integrate and deploy an example contract
Apply the policy to the example contract
Verify functionality
NOTE: This guide was developed in a MacOS environment, some modification may be necessary to suit a Linux/Windows environment.
An Anvil dumpState file is provided with a pre-deployed Rules Engine instance. Start the local Anvil instance in a terminal window with the following command:
Copy
Ask AI
anvil --load-state anvilState.json
Listening on 127.0.0.1:8545 should be the last thing displayed if the state file was successfuly loaded. Leave this Anvil instance running in this terminal for the rest of the quickstart. It may be restarted at any time but restarting will lose any on-chain progress you’ve made during the quickstart.
The .env.sample environment file contains the values needed to continue this guide. Expand the Accordion below for more information.
Environment File Details
RPC_URL - The RPC endpoint to utilize when interacting with an EVM chain. This is defaulted to a local anvil RPC that is enabled when starting anvil. This can be updated to point to any testnet/mainnet RPC if desired. See anvil for more details.
Copy
Ask AI
# local anvil RPC, change this if you're deploying to a networkRPC_URL=http://127.0.0.1:8545
PRIV_KEY - The private key for the account that will be performing the actions outlined in this guide. This is defaulted to a widely known default Anvil account for the purposes of this guide. It is recommended that this be updated prior to deploying to any testnet or mainnet.
Copy
Ask AI
# local anvil account private key, change to your deployer wallet key when using a live networkPRIV_KEY=0xac0974bec39a17e36ba4a6b4d238ff944bacb478cbed5efcae784d7bf4f2ff80
RULES_ENGINE_ADDRESS - The address of the deployed Rules Engine instance on the target RPC’s chain. This is defaulted to the address where the Rules Engine was deployed in the anvilState.json file. For additional chain locations, please see the Forte Rules Engine docs.
Copy
Ask AI
# address of the rules engine within the anvil state fileRULES_ENGINE_ADDRESS=0x2279B7A0a67DB372996a5FaB50D91eAA73d2eBe6
Copy the sample environment file and then source the file to make those values available in your terminal.
Copy
Ask AI
cp .env.sample .env
Copy
Ask AI
source .env
The SDK utilizes the Rules Engine address and private key values from the environment file. This
requires that you name your file .env, which enables the SDK to access the values.
To use the Rules engine, we must first create a policy. A default policy has been written for you within the policy.json that is tailored to work with the ExampleContract. To create this policy in the Rules Engine, run the following command:
Copy
Ask AI
npx tsx index.ts setupPolicy policy.json
Note the returned Policy Id, for this example the Policy Id should be 1, and create a local environment variable to store this Id for uses in subsequent commands:
Copy
Ask AI
export POLICY_ID=1
This policy now exists, but no contracts are yet subscribed to it.
The ExampleContract is a blank contract that conforms to a standard ERC20 interface transfer() function. The file does not store any data. The integration of the Rules Engine occurs by adding a modifier. This modifier may be generated by passing the policy information, destination modifier filename, and the example contract to the SDK. The SDK will process the policy, generate modifiers within the specified modifier file for each function within the Policy, and inject these newly generated modifiers within the supplied contract. This has been scripted in the index.ts with the following command:
After running this command, it will inject the beforeXXX() modifier within the function specified within the policy.json file. Verify the contract compiles and deploy the contract with the following commands:
The ExampleContract extends the RulesEngineClient to encapsulate storing the Rules Engine address and checks. It is recommended that all calling contracts extend this contract. This ensures calling contracts will only invoke the Rules Engine checks if the Rules Engine Address is specified. Set the Rules Engine Address in the ExampleContract via the following command:First, we need to set the Rules Engine Address for the ExampleContract.