Awesome

Overview

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.

Usage

Proposal Simulation

Step 1: Install

Add forge-proposal-simulator to your project using Forge:

forge install https://github.com/solidity-labs-io/forge-proposal-simulator.git

Step 2: Set Remappings

Update your remappings.txt to include:

echo @forge-proposal-simulator=lib/forge-proposal-simulator/ >> remappings.txt

Step 3: Create Addresses File

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"}]

Step 4: Create a Proposal

Choose a model that fits your needs:

• Multisig Proposal
• Timelock Proposal
• Governor Bravo Proposal
• OZ Governor proposal

Step 5: Implement Scripts and Tests

Create scripts and/or tests. Check Guides and Integration Tests.

Contribute

There are many ways you can participate and help build the next version of FPS. Check out the contribution guide!

License

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.