# Multisig Proposal ## Overview Following the addition of FPS to project dependencies, the next step is creating a Proposal contract. This example serves as a guide for drafting a proposal for a Multisig contract. ## Proposal contract The `MultisigProposal_01` proposal is available in the [fps-example-repo](https://github.com/solidity-labs-io/fps-example-repo/blob/main/src/proposals/simple-vault-multisig/MultisigProposal_01.sol). This contract is used as a reference for this tutorial. Let's go through each of the functions that are overridden. * `name()`: Define the name of your proposal. ```solidity function name() public pure override returns (string memory) { return "MULTISIG_MOCK"; } ``` * `description()`: Provide a detailed description of your proposal. ```solidity function description() public pure override returns (string memory) { return "Multisig proposal mock"; } ``` * `deploy()`: Deploy any necessary contracts. This example demonstrates the deployment of Vault and an ERC20 token. Once the contracts are deployed, they are added to the `Addresses` contract by calling `addAddress()`. ```solidity function deploy() public override { // get multisig address address multisig = addresses.getAddress("DEV_MULTISIG"); // Deploy vault address if not already deployed and transfer ownership to multisig. if (!addresses.isAddressSet("MULTISIG_VAULT")) { Vault multisigVault = new Vault(); addresses.addAddress( "MULTISIG_VAULT", address(multisigVault), true ); multisigVault.transferOwnership(multisig); } // Deploy token address if not already deployed, transfer ownership to multisig // and transfer all initial minted tokens from deployer to multisig. if (!addresses.isAddressSet("MULTISIG_TOKEN")) { Token token = new Token(); addresses.addAddress("MULTISIG_TOKEN", address(token), true); token.transferOwnership(multisig); // During forge script execution, the deployer of the contracts is // the DEPLOYER_EOA. However, when running through forge test, the deployer of the contracts is this contract. uint256 balance = token.balanceOf(address(this)) > 0 ? token.balanceOf(address(this)) : token.balanceOf(addresses.getAddress("DEPLOYER_EOA")); token.transfer(multisig, balance); } } ``` * `build()`: Add actions to the proposal contract. In this example, an ERC20 token is whitelisted on the Vault contract. Then the multisig approves the token to be spent by the vault, and calls deposit on the vault. The actions should be written in solidity code and in the order they should be executed in the proposal. Any calls (except to the Addresses and Foundry Vm contract) will be recorded and stored as actions to execute in the run function. The `caller` address that will call actions is passed into `buildModifier`, it is the multisig for this example. The `buildModifier` is necessary modifier for `build` function and will not work without it. For further reading, see the [build function](https://docs.soliditylabs.io/forge-proposal-simulator/overview/architecture/proposal-functions#build-function). ```solidity function build() public override buildModifier(addresses.getAddress("DEV_MULTISIG")) { /// STATICCALL -- non-mutative and hence not recorded for the run stage // Get multisig address address multisig = addresses.getAddress("DEV_MULTISIG"); // Get vault address address multisigVault = addresses.getAddress("MULTISIG_VAULT"); // Get token address address token = addresses.getAddress("MULTISIG_TOKEN"); // Get multisig's token balance uint256 balance = Token(token).balanceOf(address(multisig)); /// CALLS -- mutative and recorded // Whitelists the deployed token on the deployed vault. Vault(multisigVault).whitelistToken(token, true); // Approve the token for the vault. Token(token).approve(multisigVault, balance); // Deposit all tokens into the vault. Vault(multisigVault).deposit(token, balance); } ``` * `run()`: Sets up the environment for running the proposal, and executes all proposal actions. This sets `addresses`, `primaryForkId` and calls `super.run()` run the entire proposal. In this example, `primaryForkId` is set to `sepolia` and selecting the fork for running proposal. Next the `addresses` object is set by reading from the JSON file. For further reading, see the [run function](https://docs.soliditylabs.io/forge-proposal-simulator/overview/architecture/proposal-functions#run-function). ```solidity function run() public override { // Create and select sepolia fork for proposal execution primaryForkId = vm.createFork("sepolia"); vm.selectFork(primaryForkId); string memory addressesFolderPath = "./addresses"; uint256[] memory chainIds = new uint256[](1); chainIds[0] = 11155111; // Set addresses object reading addresses from json file. setAddresses( new Addresses(addressesFolderPath, chainIds) ); // Call the run function of parent contract 'Proposal.sol'. super.run(); } ``` * `simulate()`: Execute the proposal actions outlined in the `build()` step. This function performs a call to `_simulateActions()` from the inherited `MultisigProposal` contract. Internally, `_simulateActions()` simulates a call to the [Multicall3](https://www.multicall3.com/) contract with the calldata generated from the actions set up in the build step. Multicall contract is used to execute all of the actions together in a single safe action. This is done by batching all the build actions together using the `aggregate3Value` multicall3 function. The single safe action is a delegate call to the multicall3 contract as the caller for all the batched actions should be the multisig contract and not the multicall3 contract. ```solidity function simulate() public override { // Get multisig address address multisig = addresses.getAddress("DEV_MULTISIG"); // multisig is the caller for all the proposal actions _simulateActions(multisig); } ``` * `validate()`: This final step validates the system in its post-execution state. It ensures that the multisig is the new owner of Vault and token, the tokens were transferred to the multisig, and the token was whitelisted on the Vault contract ```solidity function validate() public override { // Get vault address Vault multisigVault = Vault(addresses.getAddress("MULTISIG_VAULT")); // Get token address Token token = Token(addresses.getAddress("MULTISIG_TOKEN")); // Get multisig address address multisig = addresses.getAddress("DEV_MULTISIG"); // Ensure token total supply is 10 million assertEq(token.totalSupply(), 10_000_000e18); // Ensure multisig is owner of deployed token. assertEq(token.owner(), multisig); // Ensure multisig is owner of deployed vault assertEq(multisigVault.owner(), multisig); // Ensure vault is not paused assertFalse(multisigVault.paused()); // Ensure token is whitelisted on vault assertTrue(multisigVault.tokenWhitelist(address(token))); // Get vault's token balance uint256 balance = token.balanceOf(address(multisigVault)); // Get multisig deposits in vault (uint256 amount, ) = multisigVault.deposits(address(token), multisig); // Ensure multisig deposit is same as vault's token balance assertEq(amount, balance); // Ensure all minted tokens are deposited into the vault assertEq(token.balanceOf(address(multisigVault)), token.totalSupply()); } ``` ## Proposal simulation ### Deploying a Gnosis Safe Multisig on Testnet To kick off this tutorial, a Gnosis Safe Multisig contract is needed to be set up on the testnet. 1. Go to [Gnosis Safe](https://app.safe.global/) and pick your preferred testnet (Sepolia is used for this tutorial). Follow the on-screen instructions to generate a new Safe Account. 2. After setting up the Safe, its address can be found in the details section of the Safe Account. Make sure to copy this address and keep it handy for later steps. ### Setting Up the Addresses JSON Set up `11155111.json` file and add the Gnosis Safe address and deployer address to it. The file should follow this structure: ```json [ { "addr": "0x", "name": "DEV_MULTISIG", "isContract": true }, { "addr": "0x ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.