Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/solidity-labs-io/forge-proposal-simulator
Standard way to simulate governance actions from a timelock, multisig, or DAO.
https://github.com/solidity-labs-io/forge-proposal-simulator
Last synced: about 2 months ago
JSON representation
Standard way to simulate governance actions from a timelock, multisig, or DAO.
- Host: GitHub
- URL: https://github.com/solidity-labs-io/forge-proposal-simulator
- Owner: solidity-labs-io
- License: mit
- Created: 2023-12-15T20:04:40.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-05-21T23:21:57.000Z (8 months ago)
- Last Synced: 2024-05-22T11:01:44.912Z (8 months ago)
- Language: Solidity
- Size: 533 KB
- Stars: 42
- Watchers: 3
- Forks: 7
- Open Issues: 14
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
- awesome-foundry - Forge Proposal Simulator - A tool to write, simulate and test governance proposals. (Tools)
README
# 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](https://solidity-labs.gitbook.io/forge-proposal-simulator/).
## Usage
### Proposal Simulation
#### Step 1: Install
Add `forge-proposal-simulator` to your project using Forge:
```sh
forge install https://github.com/solidity-labs-io/forge-proposal-simulator.git
```
#### Step 2: Set Remappings
Update your remappings.txt to include:
```sh
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](docs/overview/architecture/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`.
```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](docs/guides/multisig-proposal.md)
- [Timelock Proposal](docs/guides/timelock-proposal.md)
- [Governor Bravo Proposal](docs/guides/governor-bravo-proposal.md)
- [OZ Governor proposal](docs/guides/oz-governor-proposal.md)
#### Step 5: Implement Scripts and Tests
Create scripts and/or tests. Check [Guides](docs/guides/multisig-proposal.md) and [Integration Tests](docs/testing/integration-tests.md).
## Contribute
There are many ways you can participate and help build the next version of FPS. Check out the [contribution guide](CONTRIBUTING.md)!
## 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](LICENSE).