feat: apella (#9084)

Fixes #8137.

l1-contracts/.solhint.json

@@ -20,10 +20,10 @@
       "error"
     ],
     "not-rely-on-time": "off",
-    "const-name-snakecase": [
-      "error",
+    "immutable-vars-naming": [
+      "warn",
       {
-        "treatImmutableVarAsConstant": true
+        "immutablesAsConstants": true
       }
     ],
     "var-name-mixedcase": [
@@ -47,6 +47,7 @@
     "func-param-name-leading-underscore": [
       "error"
     ],
+    "interface-starts-with-i": "warn",
     "func-param-name-mixedcase": [
       "error"
     ],
@@ -62,6 +63,7 @@
     "comprehensive-interface": [
       "error"
     ],
-    "custom-error-over-require": "off"
+    "custom-error-over-require": "off",
+    "no-unused-import": "error"
   }
 }

l1-contracts/foundry.toml

@@ -6,7 +6,8 @@ solc = "0.8.27"
 
 remappings = [
   "@oz/=lib/openzeppelin-contracts/contracts/",
-  "@aztec/=src"
+  "@aztec/=src",
+  "@test/=test"
 ]
 
 # See more config options https://github.com/foundry-rs/foundry/tree/master/config

l1-contracts/src/governance/Apella.sol

@@ -0,0 +1,288 @@
+// SPDX-License-Identifier: UNLICENSED
+pragma solidity >=0.8.27;
+
+import {IPayload} from "@aztec/governance/interfaces/IPayload.sol";
+import {IApella} from "@aztec/governance/interfaces/IApella.sol";
+
+import {DataStructures} from "@aztec/governance/libraries/DataStructures.sol";
+import {ConfigurationLib} from "@aztec/governance/libraries/ConfigurationLib.sol";
+import {Errors} from "@aztec/governance/libraries/Errors.sol";
+import {ProposalLib, VoteTabulationReturn} from "@aztec/governance/libraries/ProposalLib.sol";
+import {UserLib} from "@aztec/governance/libraries/UserLib.sol";
+
+import {Timestamp} from "@aztec/core/libraries/TimeMath.sol";
+
+import {IERC20} from "@oz/token/ERC20/IERC20.sol";
+import {SafeERC20} from "@oz/token/ERC20/utils/SafeERC20.sol";
+
+contract Apella is IApella {
+  using SafeERC20 for IERC20;
+  using ProposalLib for DataStructures.Proposal;
+  using UserLib for DataStructures.User;
+  using ConfigurationLib for DataStructures.Configuration;
+
+  IERC20 public immutable ASSET;
+
+  address public gerousia;
+
+  mapping(uint256 proposalId => DataStructures.Proposal) internal proposals;
+  mapping(uint256 proposalId => mapping(address user => DataStructures.Ballot)) public ballots;
+  mapping(address => DataStructures.User) internal users;
+  mapping(uint256 withdrawalId => DataStructures.Withdrawal) internal withdrawals;
+
+  DataStructures.Configuration internal configuration;
+  DataStructures.User internal total;
+  uint256 public proposalCount;
+  uint256 public withdrawalCount;
+
+  constructor(IERC20 _asset, address _gerousia) {
+    ASSET = _asset;
+    gerousia = _gerousia;
+
+    configuration = DataStructures.Configuration({
+      votingDelay: Timestamp.wrap(3600),
+      votingDuration: Timestamp.wrap(3600),
+      executionDelay: Timestamp.wrap(3600),
+      gracePeriod: Timestamp.wrap(3600),
+      quorum: 0.1e18,
+      voteDifferential: 0.04e18,
+      minimumVotes: 1000e18
+    });
+    configuration.assertValid();
+  }
+
+  function updateGerousia(address _gerousia) external override(IApella) {
+    require(msg.sender == address(this), Errors.Apella__CallerNotSelf(msg.sender, address(this)));
+    gerousia = _gerousia;
+    emit GerousiaUpdated(_gerousia);
+  }
+
+  function updateConfiguration(DataStructures.Configuration memory _configuration)
+    external
+    override(IApella)
+  {
+    require(msg.sender == address(this), Errors.Apella__CallerNotSelf(msg.sender, address(this)));
+
+    // This following MUST revert if the configuration is invalid
+    _configuration.assertValid();
+
+    configuration = _configuration;
+
+    emit ConfigurationUpdated(Timestamp.wrap(block.timestamp));
+  }
+
+  function deposit(address _onBehalfOf, uint256 _amount) external override(IApella) {
+    ASSET.safeTransferFrom(msg.sender, address(this), _amount);
+    users[_onBehalfOf].add(_amount);
+    total.add(_amount);
+
+    emit Deposit(msg.sender, _onBehalfOf, _amount);
+  }
+
+  function initiateWithdraw(address _to, uint256 _amount)
+    external
+    override(IApella)
+    returns (uint256)
+  {
+    users[msg.sender].sub(_amount);
+    total.sub(_amount);
+
+    uint256 withdrawalId = withdrawalCount++;
+
+    withdrawals[withdrawalId] = DataStructures.Withdrawal({
+      amount: _amount,
+      unlocksAt: Timestamp.wrap(block.timestamp) + configuration.lockDelay(),
+      recipient: _to,
+      claimed: false
+    });
+
+    emit WithdrawInitiated(withdrawalId, _to, _amount);
+
+    return withdrawalId;
+  }
+
+  function finaliseWithdraw(uint256 _withdrawalId) external override(IApella) {
+    DataStructures.Withdrawal storage withdrawal = withdrawals[_withdrawalId];
+    require(!withdrawal.claimed, Errors.Apella__WithdrawalAlreadyclaimed());
+    require(
+      Timestamp.wrap(block.timestamp) >= withdrawal.unlocksAt,
+      Errors.Apella__WithdrawalNotUnlockedYet(Timestamp.wrap(block.timestamp), withdrawal.unlocksAt)
+    );
+    withdrawal.claimed = true;
+
+    emit WithdrawFinalised(_withdrawalId);
+
+    ASSET.safeTransfer(withdrawal.recipient, withdrawal.amount);
+  }
+
+  function propose(IPayload _proposal) external override(IApella) returns (bool) {
+    require(msg.sender == gerousia, Errors.Apella__CallerNotGerousia(msg.sender, gerousia));
+
+    uint256 proposalId = proposalCount++;
+
+    proposals[proposalId] = DataStructures.Proposal({
+      config: configuration,
+      state: DataStructures.ProposalState.Pending,
+      payload: _proposal,
+      creator: msg.sender,
+      creation: Timestamp.wrap(block.timestamp),
+      summedBallot: DataStructures.Ballot({yea: 0, nea: 0})
+    });
+
+    emit Proposed(proposalId, address(_proposal));
+
+    return true;
+  }
+
+  function vote(uint256 _proposalId, uint256 _amount, bool _support)
+    external
+    override(IApella)
+    returns (bool)
+  {
+    DataStructures.ProposalState state = getProposalState(_proposalId);
+    require(state == DataStructures.ProposalState.Active, Errors.Apella__ProposalNotActive());
+
+    // Compute the power at the time where we became active
+    uint256 userPower = users[msg.sender].powerAt(proposals[_proposalId].pendingThrough());
+
+    DataStructures.Ballot storage userBallot = ballots[_proposalId][msg.sender];
+
+    uint256 availablePower = userPower - (userBallot.nea + userBallot.yea);
+    require(
+      _amount <= availablePower,
+      Errors.Apella__InsufficientPower(msg.sender, availablePower, _amount)
+    );
+
+    DataStructures.Ballot storage summedBallot = proposals[_proposalId].summedBallot;
+    if (_support) {
+      userBallot.yea += _amount;
+      summedBallot.yea += _amount;
+    } else {
+      userBallot.nea += _amount;
+      summedBallot.nea += _amount;
+    }
+
+    emit VoteCast(_proposalId, msg.sender, _support, _amount);
+
+    return true;
+  }
+
+  function execute(uint256 _proposalId) external override(IApella) returns (bool) {
+    DataStructures.ProposalState state = getProposalState(_proposalId);
+    require(
+      state == DataStructures.ProposalState.Executable, Errors.Apella__ProposalNotExecutable()
+    );
+
+    DataStructures.Proposal storage proposal = proposals[_proposalId];
+    proposal.state = DataStructures.ProposalState.Executed;
+
+    IPayload.Action[] memory actions = proposal.payload.getActions();
+
+    for (uint256 i = 0; i < actions.length; i++) {
+      require(actions[i].target != address(ASSET), Errors.Apella__CannotCallAsset());
+      // We allow calls to EOAs. If you really want be my guest.
+      (bool success,) = actions[i].target.call(actions[i].data);
+      require(success, Errors.Apella__CallFailed(actions[i].target));
+    }
+
+    emit ProposalExecuted(_proposalId);
+
+    return true;
+  }
+
+  function powerAt(address _owner, Timestamp _ts) external view override(IApella) returns (uint256) {
+    if (_ts == Timestamp.wrap(block.timestamp)) {
+      return users[_owner].powerNow();
+    }
+    return users[_owner].powerAt(_ts);
+  }
+
+  function totalPowerAt(Timestamp _ts) external view override(IApella) returns (uint256) {
+    if (_ts == Timestamp.wrap(block.timestamp)) {
+      return total.powerNow();
+    }
+    return total.powerAt(_ts);
+  }
+
+  function getConfiguration() external view returns (DataStructures.Configuration memory) {
+    return configuration;
+  }
+
+  function getProposal(uint256 _proposalId) external view returns (DataStructures.Proposal memory) {
+    return proposals[_proposalId];
+  }
+
+  function getWithdrawal(uint256 _withdrawalId)
+    external
+    view
+    returns (DataStructures.Withdrawal memory)
+  {
+    return withdrawals[_withdrawalId];
+  }
+
+  function dropProposal(uint256 _proposalId) external returns (bool) {
+    DataStructures.Proposal storage self = proposals[_proposalId];
+    require(
+      self.state != DataStructures.ProposalState.Dropped, Errors.Apella__ProposalAlreadyDropped()
+    );
+    require(
+      getProposalState(_proposalId) == DataStructures.ProposalState.Dropped,
+      Errors.Apella__ProposalCannotBeDropped()
+    );
+
+    self.state = DataStructures.ProposalState.Dropped;
+    return true;
+  }
+
+  /**
+   * @notice	Get the state of the proposal
+   *
+   * @dev			Currently optimised for readability NOT gas.
+   *
+   */
+  function getProposalState(uint256 _proposalId)
+    public
+    view
+    override(IApella)
+    returns (DataStructures.ProposalState)
+  {
+    require(_proposalId < proposalCount, Errors.Apella__ProposalDoesNotExists(_proposalId));
+
+    DataStructures.Proposal storage self = proposals[_proposalId];
+
+    if (self.isStable()) {
+      return self.state;
+    }
+
+    // If the gerousia have changed we mark is as dropped
+    if (gerousia != self.creator) {
+      return DataStructures.ProposalState.Dropped;
+    }
+
+    Timestamp currentTime = Timestamp.wrap(block.timestamp);
+
+    if (currentTime <= self.pendingThrough()) {
+      return DataStructures.ProposalState.Pending;
+    }
+
+    if (currentTime <= self.activeThrough()) {
+      return DataStructures.ProposalState.Active;
+    }
+
+    uint256 totalPower = total.powerAt(self.pendingThrough());
+    (VoteTabulationReturn vtr,) = self.voteTabulation(totalPower);
+    if (vtr != VoteTabulationReturn.Accepted) {
+      return DataStructures.ProposalState.Rejected;
+    }
+
+    if (currentTime <= self.queuedThrough()) {
+      return DataStructures.ProposalState.Queued;
+    }
+
+    if (currentTime <= self.executableThrough()) {
+      return DataStructures.ProposalState.Executable;
+    }
+
+    return DataStructures.ProposalState.Expired;
+  }
+}