search

Timelock Proposal

hashtag
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 Timelock contract.

hashtag
Proposal Contract

The TimelockProposal_01 proposal is available in the fps-example-repoarrow-up-right. This contract is used as a reference for this tutorial.

Let's review each of the functions that are overridden.

  • name(): This function defines the name of your proposal.

    function name() public pure override returns (string memory) {
    return "TIMELOCK_MOCK";
}

  • description(): It provides a detailed description of your proposal.

    function description() public pure override returns (string memory) {
    return "Timelock proposal mock";
}

  • deploy(): This function deploys any necessary contracts. In this example, it demonstrates the deployment of Vault and an ERC20 token. Once the contracts are deployed, they are added to the Addresses contract by calling addAddress().

    function deploy() public override {
    // Deploy vault address if not already deployed and transfer ownership to timelock.
    if (!addresses.isAddressSet("TIMELOCK_VAULT")) {
        Vault timelockVault = new Vault();

        addresses.addAddress(
            "TIMELOCK_VAULT",
            address(timelockVault),
            true
        );

        timelockVault.transferOwnership(address(timelock));
    }

    // Deploy token address if not already deployed, transfer ownership to timelock
    // and transfer all initial minted tokens from deployer to timelock.
    if (!addresses.isAddressSet("TIMELOCK_TOKEN")) {
        Token token = new Token();
        addresses.addAddress("TIMELOCK_TOKEN", address(token), true);
        token.transferOwnership(address(timelock));

        // 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(address(timelock), balance);
    }
}

  • build(): Add actions to the proposal contract. In this example, an ERC20 token is whitelisted on the Vault contract. Then the timelock 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 timelock for this example. The buildModifier is a necessary modifier for the build function and will not work without it. For further reading, see the build function.

    function build() public override buildModifier(address(timelock)) {
    /// STATICCALL -- non-mutative and hence not recorded for the run stage

    // Get vault address
    address timelockVault = addresses.getAddress("TIMELOCK_VAULT");

    // Get token address
    address token = addresses.getAddress("TIMELOCK_TOKEN");

    // Get timelock's token balance.
    uint256 balance = Token(token).balanceOf(address(timelock));

    /// CALLS -- mutative and recorded

    // Whitelists the deployed token on the deployed vault.
    Vault(timelockVault).whitelistToken(token, true);

    // Approve the token for the vault.
    Token(token).approve(timelockVault, balance);

    // Deposit all tokens into the vault.
    Vault(timelockVault).deposit(token, balance);
}

  • run(): Sets up the environment for running the proposal, and executes all proposal actions. This sets addresses, primaryForkId, and timelock and calls super.run() to run the entire proposal. In this example, primaryForkId is set to sepolia for running the proposal. Next, the addresses object is set by reading the JSON file. The timelock contract to test is set using setTimelock. This will be used to check onchain calldata and simulate the proposal. For further reading, see the run function.

    function run() public override {
    // Create and select the 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 the addresses object by reading addresses from the json file.
    setAddresses(
        new Addresses(addressesFolderPath, chainIds)
    );

    // Set the timelock; this address is used for proposal simulation and checking on-chain proposal state
    setTimelock(addresses.getAddress("PROTOCOL_TIMELOCK"));

    // Call the run function of the parent contract 'Proposal.sol'
    super.run();
}

  • simulate(): This function executes the proposal actions outlined in the build() step. It performs a call to _simulateActions from the inherited TimelockProposal contract. Internally, _simulateActions() simulates a call to Timelock scheduleBatcharrow-up-right and executeBatcharrow-up-right with the calldata generated from the actions set up in the build step.

    function simulate() public override {
    // Get dev address for simulation
    address dev = addresses.getAddress("DEPLOYER_EOA");

    /// Dev is proposer and executor of timelock
    _simulateActions(dev, dev);
}

  • validate(): This final step validates the system in its post-execution state. It ensures that the timelock is the new owner of the Vault and token, the tokens were transferred to the timelock, and the token was whitelisted on the Vault contract.

    function validate() public override {
    // Get vault address
    Vault timelockVault = Vault(addresses.getAddress("TIMELOCK_VAULT"));

    // Get token address
    Token token = Token(addresses.getAddress("TIMELOCK_TOKEN"));

    // Ensure the total supply of tokens is 10 million
    assertEq(token.totalSupply(), 10_000_000e18);

    // Ensure the timelock is the owner of the deployed token
    assertEq(token.owner(), address(timelock));

    // Ensure the timelock is the owner of the deployed vault
    assertEq(timelockVault.owner(), address(timelock));

    // Ensure the vault is not paused
    assertFalse(timelockVault.paused());

    // Ensure the token is whitelisted on the vault
    assertTrue(timelockVault.tokenWhitelist(address(token)));

    // Get the vault's token balance
    uint256 balance = token.balanceOf(address(timelockVault));

    // Get the timelock deposits in the vault
    (uint256 amount, ) = timelockVault.deposits(
        address(token),
        address(timelock)
    );

    // Ensure the timelock deposit is the same as the vault's token balance
    assertEq(amount, balance);

    // Ensure all minted tokens are deposited into the vault
    assertEq(token.balanceOf(address(timelockVault)), token.totalSupply());
}

hashtag
Proposal Simulation

hashtag
Deploying a Timelock Controller on Testnet

Before executing the proposal, set up a Timelock Controller contract on the testnet. A script DeployTimelockarrow-up-right is provided to streamline this process.

Before running the script, add the DEPLOYER_EOA address to the 11155111.json file.

After adding the address, execute the script:

Ensure that the ${wallet_name} and ${wallet_address} accurately correspond to the wallet details saved in ~/.foundry/keystores/.

hashtag
Setting Up the Addresses JSON

Add the Timelock Controller address to the JSON file. The file should follow this structure:

hashtag
Running the Proposal

The script will output the following:

It is crucial to note that two new addresses have been added to the Addresses.sol storage. These addresses are not included in the JSON files when proposal is run without the DO_UPDATE_ADDRESS_JSON flag set to true.

The proposal script will deploy the contracts in the deploy() method and will generate action calldata for each individual action, along with schedule and execute calldatas for the proposal. The proposal can be scheduled and executed manually using cast send along with the calldata generated above.

PreviousMultisig ProposalNextGovernor Bravo Proposal

Last updated