contracts

Forest Network - Smartcontracts

High-level View

This is Forest Network Smartcontracts. This suite of modularised immutable code is divided up into four contracts which govern the following main areas of concern:

• ForestRegistry contract: reponsible for keeping track of all actor registrations, Protocols (including spinning up new ones) and collecting registration fees;
• ForestProtocol contract: responsible for a single Forest Network Protocol (PT) specific logic of enforcing PT rules and facilitating Providers entering Agreements with Users. Includes logic for processing Agreement balances and fees;
• ForestSlasher contract: responsible for managing Actor's collateral, accepting votes from Validators on Provider's performance and aggregating the granular scores into aggregates which are used subsequently in emissions and slashing processes;
• ForestToken contract: responsible for calculating and emitting new FOREST tokens based on info from Slasher as well as supporting typical ERC-20 functionality like transfers, burning and approvals.

How to Interact with the Protocol

There are three main ways to interact with the Protocol:

1. CLI: link to npm
2. Etherscan: check out the "Current live deployments" section below for explorer links to verified contracts
3. Marketplace Web App by Forest Protocols: work-in-progress

For test tokens:

• USDC: https://faucet.circle.com/
• FOREST: contact the team on Discord

Code-level Assumptions

1. Order of deployment is important:

• new ForestToken()
• new ForestSlasher()
• new ForestRegistry()
• slasher.setRegistryAndForestAddr(address(registry))
• forestToken.setRegistryAndSlasherAddr(address(registry))

2. An address can register only as one type of actor both on the Network level and on the PTs level.
3. The PT smartcontracts are functional with the assumption that they were deployed by the ForestRegistry contract. Standalone deployment of PT code is not supported.
4. Collateral related functions can only be called by the Owner address, not the Operator address.

Installation and Config

• Install foundry: link
• Clone repo
• Change .env.example to .env and fill all the required fields
• Might need forge install Openzeppelin/openzeppelin-contracts-upgradeable --no-commit and forge install Openzeppelin/openzeppelin-contracts --no-commit

Useful Commands

• Compile: forge build
• Run tests with detailed logging: forge test -vvvv
• Update env vars in .env
• Load env vars from file source .env
• Run scripts
  • e.g. deployment for Base Sepolia: forge script --chain 84532 script/DeployForestContracts.sol:DeployScript --rpc-url $BASE_SEPOLIA_RPC_URL --broadcast --verify --etherscan-api-key $BASE_SEPOLIA_API_KEY -vvvv (env vars: RUN_ON set to 1, BASE_SEPOLIA_PRIV_KEY filled out)
  • deployment on local Anvil: forge script script/DeployForestContracts.sol:DeployScript --rpc-url 127.0.0.1:8545 --broadcast (env vars: RUN_ON set to 0, LOCAL_PRIV_KEY filled out)
• (Generate interface from ABI: cast interface -n IForestRegistry utils/ForestRegistry.abi > IForestRegistry.sol)

Instructions for Minimal Anvil Deployment for Testing

This will produce a network with two protocols, each with two providers and one validator as well as two closed epochs and one rewards emission event.

Prerequisite:

• change ForestSlasher values for epoch length and reveal window

  uint256 public EPOCH_LENGTH = 10; 
  uint256 public REVEAL_WINDOW = 4; 
  

Steps:

1. source .env
2. forge script script/DeployForestContracts.sol:DeployScript --rpc-url 127.0.0.1:8545 --broadcast
3. update .env file with contract addresses (registry, token, mockedusdc, slasher)
4. source .env
5. forge script script/MinimalAnvilTestDeployment.sol:MinimalAnvilTestDeployment --rpc-url 127.0.0.1:8545 --broadcast
6. update address public constant PT1_ADDR = ... and address public constant PT2_ADDR = ... in script/MinimalAnvilTestDeployment.solfile with deployed protocol addresses (see addresses in logs from execution of the last command)
7. forge script script/MinimalAnvilTestDeployment.sol:MinimalAnvilTestDeployment --sig "enter2AgreementsAsValidator()" --rpc-url 127.0.0.1:8545 --broadcast
8. forge script script/MinimalAnvilTestDeployment.sol:MinimalAnvilTestDeployment --sig "closeCurrentEpoch" --rpc-url 127.0.0.1:8545 --broadcast
9. forge script script/MinimalAnvilTestDeployment.sol:MinimalAnvilTestDeployment --sig "commitResults()" --rpc-url 127.0.0.1:8545 --broadcast
10. cast rpc evm_mine until block 61
11. forge script script/MinimalAnvilTestDeployment.sol:MinimalAnvilTestDeployment --sig "revealResults()" --rpc-url 127.0.0.1:8545 --broadcast
12. cast rpc evm_mine until block 65
13. forge script script/MinimalAnvilTestDeployment.sol:MinimalAnvilTestDeployment --sig "closeCurrentEpoch" --rpc-url 127.0.0.1:8545 --broadcast
14. forge script script/MinimalAnvilTestDeployment.sol:MinimalAnvilTestDeployment --sig "emitRewards" --rpc-url 127.0.0.1:8545 --broadcast

Current live deployments

Base Sepolia

[current] v0.45 (private purchases via user whitelist, changed events for emissions)

• [dev env] ForestRegistry contract: 0x2F1c43d20E8A99DE2fb4e3375aDd29fbD1e5Eff0: explorer link
• [dev env] ForestSlasher contract: 0x55d2db9e358a0e3094fa0e7811edf545ebb4f156: explorer link
• [dev env] ForestToken contract: 0x7d9A7D5F382E71AaCab227D96B9cd95218E36f30: explorer link
• [dev env] MockedUsdcToken contracts: 0xC80ca08851aE3F9d947eb78E1E2d810556AF1303: explorer link

Optimism Sepolia

[previous] v0.44 (bug fixes, optimisations for easier SDK interactions)

• [dev env] ForestRegistry contract: 0x2dF5969aE1eACAbE5e911F49Eb07f9Ce900942dB: explorer link
• [dev env] ForestSlasher contract: 0xE5baE709081755Dc97aDd9c40ab4bFF505eC0D2c: explorer link
• [dev env] ForestToken contract: 0xF52A100Ae7ddB4aC9d6dB508C9DF9c7613CAe06E: explorer link
• [dev env] MockedUsdcToken contracts: 0x8A278cc8f4c0c8A93B322b5461153fAcf4121112: explorer link

v0.43 (makes Slasher epoch & reveal window changeable for testing + optimisations)

• [dev env] ForestRegistry contract: 0xfd57c88098550f2929c1200400Cf611Be207eBC4: explorer link
• [dev env] ForestSlasher contract: 0xbC970527ac59E19DD12D4b4F69627e9eC354E848: explorer link
• [dev env] ForestToken contract: 0x3b494BcC7c9dE07610269eFE0305f2906845E2e7: explorer link

v0.42 (unified errors + bitcoin-like emissions)

• [dev env] ForestRegistry contract: 0x67047690DeAE36373aa29fE94C165C36f3Bc449f: explorer link
• [dev env] ForestSlasher contract: 0x387dCCFB1d0F2d15832970b6580cA56B6597Dd78: explorer link
• [dev env] ForestToken contract: 0xe9402ac2a4DB99Ee6a9BbAf3B2B2aA2EB1E9090E: explorer link

v0.41 (fixes + added emissions)

• [dev env] ForestRegistry contract: 0x768328FbEf9820b3b9908577aF4A49058ADe0f22: explorer link
• [dev env] ForestSlasher contract: 0x92C3Ed245BBEA5f13cf19b4B58B0801aFe2E64d1: explorer link
• [dev env] ForestToken contract: 0xe2e1ade600433a4b932df966e5ea3cbc38f6b47d: explorer link

v0.4

• [dev env] ForestRegistry contract: 0x9c3d09b00601dc93a64cb25a9b845c33c8a4cccc: explorer link
• [dev env] ForestSlasher contract: 0x1d1897463f1af22814dd479ba8e8fddce3cfe8ad: explorer link
• [dev env] ForestToken contract: 0xd791d2b1f77d7156e9ec419e3545460a1d2e220c: explorer link