contract-upgrades.md

Contract Upgrades

Table of Contents

• Overview
• Upgrade By Governance
  • Interface

Overview

Smart contract upgrades are executed through the governance of the Security Council. The authority to perform proxy upgrades lies with the Security Council's governor. When a proposal for an upgrade is approved, it undergoes a mandatory 7-day timelock delay period before execution.

Upgrade By Governance

When an on-chain proposal for a contract upgrade is submitted by a member of Security Council, the member votes on the proposal during the voting period. Once a proposal is approved, the Security Council queues the proposal to the batch to be executed with a 7-day timelock. After the timelock delay, the upgrade can be executed.

Interface

/**
     * @dev Create a new proposal. Vote start after a delay specified by {IGovernor-votingDelay} and lasts for a
     * duration specified by {IGovernor-votingPeriod}.
     *
     * Emits a {ProposalCreated} event.
     */
    function propose(
        address[] memory targets,
        uint256[] memory values,
        bytes[] memory calldatas,
        string memory description
    ) public virtual returns (uint256 proposalId);

/**
 * @dev Cast a vote
     *
     * Emits a {VoteCast} event.
     */
    function castVote(uint256 proposalId, uint8 support) public virtual returns (uint256 balance);

/**
     * @notice Function to queue a proposal to the timelock.
     *         Added protocol for using custom time-lock zero delay for urgent situations.
     *
     * @param _targets         The destination address that sends the message to.
     * @param _values          Amount of ether sent with the message.
     * @param _calldatas       The data portion of the message.
     * @param _descriptionHash A hashed form of the description string.
     *
     * @return Whether the challenge was canceled.
     */
    function queue(
        address[] memory _targets,
        uint256[] memory _values,
        bytes[] memory _calldatas,
        bytes32 _descriptionHash
    ) public virtual override returns (uint256);

/**
 * @dev Execute a successful proposal. This requires the quorum to be reached, the vote to be successful, and the
     * deadline to be reached.
     *
     * Emits a {ProposalExecuted} event.
     *
     * Note: some module can modify the requirements for execution, for example by adding an additional timelock.
     */
    function execute(
        address[] memory targets,
        uint256[] memory values,
        bytes[] memory calldatas,
        bytes32 descriptionHash
    ) public payable virtual returns (uint256 proposalId);