The Forge Proposal Simulator (FPS) offers a framework for creating secure governance proposals and deployment scripts, enhancing safety, and ensuring protocol health throughout the proposal lifecycle. The major benefits of using this tool are standardization of proposals, safe calldata generation, and preventing deployment and governance action bugs.
For guidance on tool usage, please read the documentation.
Add forge-proposal-simulator
to your project using Forge:
forge install https://github.com/solidity-labs-io/forge-proposal-simulator.git
Update your remappings.txt to include:
@forge-proposal-simulator=lib/forge-proposal-simulator/
Create a JSON file following the instructions provided in
Addresses.md. We recommend keeping the
addresses file in a separate folder, for example ./addresses/addresses.json
.
Once the file is created, be sure to allow read access to addresses.json
inside of foundry.toml
.
[profile.default]
...
fs_permissions = [{ access = "read", path = "./addresses/addresses.json"}]
Choose a model that fits your needs:
Create scripts and/or tests. Check Guides and Integration Tests.
Type checking allows verification of deployed bytecode on any contracts with the bytecode present in local artifacts. With this feature, developer A
can easily deploy some contracts, and developer B
can verify A
's deployments by simply running the type checking script. Additionaly, A
can also use this feature to verify their own deployments. A
can take the following steps:
- Follow the steps 1 to 3 on Proposal Simulation section
- Add the deployed contracts to
Addresses.json
. - Create a
TypeCheckAddresses.json
file following the instructions provided in type-check.md. - Enter
lib/forge-proposal-simulator/typescript
directory and install npm packages.
cd lib/forge-proposal-simulator/typescript && npm i
- Change directory again to the root repo
cd ../../../
- Add below environment variables to
.env
.
ADDRESSES_PATH # Path to addresses.json file
TYPE_CHECK_ADDRESSES_PATH # Path to typeCheckAddresses.json file
Example:
TYPE_CHECK_ADDRESSES_PATH=addresses/TypeCheckAddresses.json
ADDRESSES_PATH=addresses/Addresses.json
ARTIFACT_PATH=out/
- Make sure to allow read access to
Addresses.json
,TypeCheckAddresses.json
andartifact
folder inside offoundry.toml
.
[profile.default]
fs_permissions = [{ access = "read", path = "./"}]
- Run the following command on root repo to type check all contracts added in
TypeCheckAddresses.json
.
forge script lib/forge-proposal-simulator/script/TypeCheck.s.sol:TypeCheck --ffi --fork-url <deployed_contracts_chain_rpc_url>
TYPE_CHECK_ADDRESSES_PATH="addresses/TypeCheckAddresses.json"
ADDRESSES_PATH="addresses/Addresses.json"
LIB_PATH=""
forge script script/TypeCheck.s.sol:TypeCheck --ffi --fork-url sepolia
You can also run type checking through inline environment variables if not already set in .env
TYPE_CHECK_ADDRESSES_PATH="addresses/TypeCheckAddresses.json" ADDRESSES_PATH="addresses/Addresses.json" ARTIFACT_PATH="out/" LIB_PATH="" forge script script/TypeCheck.s.sol:TypeCheck --ffi --fork-url sepolia
There are many ways you can participate and help build the next version of FPS. Check out the contribution guide!
Forge Proposal Simulator is made available under the MIT License, which disclaims all warranties in relation to the project and which limits the liability of those that contribute and maintain the project. As set out further in the Terms, you acknowledge that you are solely responsible for any use of Forge Proposal Simulator contracts and you assume all risks associated with any such use. The authors make no warranties about the safety, suitability, reliability, timeliness, and accuracy of the software.
Further license details can be found in LICENSE.