chore: move governance out of core

docs/docs/reference/developer_references/smart_contract_reference/portals/data_structures.md

@@ -58,13 +58,11 @@ A message that is sent from L2 to L1.
 
 A snapshot of the registry values.
 
-#include_code registry_snapshot l1-contracts/src/core/libraries/DataStructures.sol solidity
+#include_code registry_snapshot l1-contracts/src/governance/libraries/DataStructures.sol solidity
 
 | Name           | Type    | Description |
 | -------------- | ------- | ----------- |
 | `rollup`       | `address` | The address of the rollup contract for the snapshot. |
-| `inbox`       | `address` | The address of the inbox contract for the snapshot. |
-| `outbox`       | `address` | The address of the outbox contract for the snapshot. |
 | `blockNumber`       | `uint256` | The block number at which the snapshot was created. |
 
 

docs/docs/reference/developer_references/smart_contract_reference/portals/registry.md

@@ -5,13 +5,13 @@ tags: [portals, contracts]
 
 The registry is a contract deployed on L1, that contains addresses for the `Rollup`. It also keeps track of the different versions that have been deployed and let you query prior deployments easily.
 
-**Links**: [Interface (GitHub link)](https://github.com/AztecProtocol/aztec-packages/blob/master/l1-contracts/src/core/interfaces/messagebridge/IRegistry.sol), [Implementation (GitHub link)](https://github.com/AztecProtocol/aztec-packages/blob/master/l1-contracts/src/core/messagebridge/Registry.sol).
+**Links**: [Interface (GitHub link)](https://github.com/AztecProtocol/aztec-packages/blob/master/l1-contracts/src/governance/interfaces/IRegistry.sol), [Implementation (GitHub link)](https://github.com/AztecProtocol/aztec-packages/blob/master/l1-contracts/src/governance/Registry.sol).
 
 ## `numberOfVersions()`
 
 Retrieves the number of versions that have been deployed.
 
-#include_code registry_number_of_versions l1-contracts/src/core/interfaces/messagebridge/IRegistry.sol solidity
+#include_code registry_number_of_versions l1-contracts/src/governance/interfaces/IRegistry.sol solidity
 
 | Name           | Description |
 | -------------- | ----------- |
@@ -20,17 +20,17 @@ Retrieves the number of versions that have been deployed.
 ## `getRollup()`
 Retrieves the current rollup contract.
 
-#include_code registry_get_rollup l1-contracts/src/core/interfaces/messagebridge/IRegistry.sol solidity
+#include_code registry_get_rollup l1-contracts/src/governance/interfaces/IRegistry.sol solidity
 
 | Name           | Description |
 | -------------- | ----------- |
 | ReturnValue    | The current rollup |
 
 ## `getVersionFor(address _rollup)`
 
-Retrieve the version of a specific rollup contract. 
+Retrieve the version of a specific rollup contract.
 
-#include_code registry_get_version_for l1-contracts/src/core/interfaces/messagebridge/IRegistry.sol solidity
+#include_code registry_get_version_for l1-contracts/src/governance/interfaces/IRegistry.sol solidity
 
 | Name           | Description |
 | -------------- | ----------- |
@@ -42,10 +42,10 @@ Will revert with `Registry__RollupNotRegistered(_rollup)` if the rollup have not
 
 ## `getSnapshot(uint256 _version)`
 
-Retrieve the snapshot of a specific version. 
+Retrieve the snapshot of a specific version.
 
-#include_code registry_snapshot l1-contracts/src/core/libraries/DataStructures.sol solidity
-#include_code registry_get_snapshot l1-contracts/src/core/interfaces/messagebridge/IRegistry.sol solidity
+#include_code registry_snapshot l1-contracts/src/governance/libraries/DataStructures.sol solidity
+#include_code registry_get_snapshot l1-contracts/src/governance/interfaces/IRegistry.sol solidity
 
 | Name           | Description |
 | -------------- | ----------- |
@@ -58,7 +58,7 @@ Retrieve the snapshot of a specific version.
 
 Retrieves the snapshot for the current version.
 
-#include_code registry_get_current_snapshot l1-contracts/src/core/interfaces/messagebridge/IRegistry.sol solidity
+#include_code registry_get_current_snapshot l1-contracts/src/governance/interfaces/IRegistry.sol solidity
 
 | Name           | Description |
 | -------------- | ----------- |

l1-contracts/README.md

@@ -56,6 +56,29 @@ Currently not running any proofs _nor_ access control so blocks can be submitted
 
 ---
 
+# Branching Tree Technique
+
+For writing tests we will be using the [Branching Tree Technique](https://www.youtube.com/watch?v=0-EmbNVgFA4).
+The approach is simple, for a function that is to be tested (all functions) you should write a `.tree` file first.
+Then the tree file can be used to generate a solidity tests file using [Bulloak](https://github.com/alexfertel/bulloak) by running the `scaffold` command.
+
+```bash
+bulloak scaffold -w **/*.tree
+```
+
+To check that the tests are following the expected format, you can run the `check` command.
+
+```bash
+bulloak check **/*.tree
+```
+
+We assume that you already have `bulloak` installed, if not you can install it as `cargo install bulloak`.
+Also, we suggest using [Ascii Tree Generator](https://marketplace.visualstudio.com/items?itemName=aprilandjan.ascii-tree-generator), since the pipes can be a bit of a pain otherwise.
+
+For examples, see the tests for the registry.
+
+---
+
 # Linter
 
 We use an extended version of solhint (https://github.com/LHerskind/solhint) to include custom rules. These custom rules relate to how errors should be named, using custom errors instead of reverts etc, see `.solhint.json` for more specifics about the rules.
@@ -73,12 +96,13 @@ yarn lint
 # Slither & Slitherin
 
 We use slither as an automatic way to find blunders and common vulnerabilities in our contracts. It is not part of the docker image due to its slowness, but it can be run using the following command to generate a markdown file with the results:
+
 ```bash
 yarn slither
 ```
 
-When this command is run in CI, it will fail if the markdown file generated in docker don't match the one in the repository. 
+When this command is run in CI, it will fail if the markdown file generated in docker don't match the one in the repository.
 
 We assume that you already have slither installed. You can install it with `pip3 install slither-analyzer==0.10.0 slitherin==0.5.0`. It is kept out of the bootstrap script as it is not a requirement for people who just want to run tests or are uninterested in the contracts.
 
-> We are not running the `naming-convention` detector because we have our own rules for naming which is enforced by the linter.
+> We are not running the `naming-convention` detector because we have our own rules for naming which is enforced by the linter.

l1-contracts/src/core/FeeJuicePortal.sol

@@ -5,7 +5,8 @@ pragma solidity >=0.8.27;
 import {IERC20} from "@oz/token/ERC20/IERC20.sol";
 import {IFeeJuicePortal} from "@aztec/core/interfaces/IFeeJuicePortal.sol";
 import {IInbox} from "@aztec/core/interfaces/messagebridge/IInbox.sol";
-import {IRegistry} from "@aztec/core/interfaces/messagebridge/IRegistry.sol";
+import {IRegistry} from "@aztec/governance/interfaces/IRegistry.sol";
+import {IRollup} from "@aztec/core/interfaces/IRollup.sol";
 
 import {Constants} from "@aztec/core/libraries/ConstantsGen.sol";
 import {DataStructures} from "@aztec/core/libraries/DataStructures.sol";
@@ -74,7 +75,7 @@ contract FeeJuicePortal is IFeeJuicePortal, Ownable {
     returns (bytes32)
   {
     // Preamble
-    IInbox inbox = registry.getRollup().INBOX();
+    IInbox inbox = IRollup(registry.getRollup()).INBOX();
     DataStructures.L2Actor memory actor = DataStructures.L2Actor(l2TokenAddress, 1);
 
     // Hash the message content to be reconstructed in the receiving contract

l1-contracts/src/core/Rollup.sol

@@ -6,7 +6,6 @@ import {IProofCommitmentEscrow} from "@aztec/core/interfaces/IProofCommitmentEsc
 import {IInbox} from "@aztec/core/interfaces/messagebridge/IInbox.sol";
 import {IOutbox} from "@aztec/core/interfaces/messagebridge/IOutbox.sol";
 import {IFeeJuicePortal} from "@aztec/core/interfaces/IFeeJuicePortal.sol";
-import {IRegistry} from "@aztec/core/interfaces/messagebridge/IRegistry.sol";
 import {IRollup, ITestRollup} from "@aztec/core/interfaces/IRollup.sol";
 import {IVerifier} from "@aztec/core/interfaces/IVerifier.sol";
 
@@ -56,7 +55,6 @@ contract Rollup is Leonidas, IRollup, ITestRollup {
   uint256 public constant PROOF_COMMITMENT_MIN_BOND_AMOUNT_IN_TST = 1000;
 
   uint256 public immutable L1_BLOCK_AT_GENESIS;
-  IRegistry public immutable REGISTRY;
   IInbox public immutable INBOX;
   IOutbox public immutable OUTBOX;
   IProofCommitmentEscrow public immutable PROOF_COMMITMENT_ESCROW;
@@ -85,15 +83,13 @@ contract Rollup is Leonidas, IRollup, ITestRollup {
   IVerifier public epochProofVerifier;
 
   constructor(
-    IRegistry _registry,
     IFeeJuicePortal _fpcJuicePortal,
     bytes32 _vkTreeRoot,
     address _ares,
     address[] memory _validators
   ) Leonidas(_ares) {
     blockProofVerifier = new MockVerifier();
     epochProofVerifier = new MockVerifier();
-    REGISTRY = _registry;
     FEE_JUICE_PORTAL = _fpcJuicePortal;
     PROOF_COMMITMENT_ESCROW = new MockProofCommitmentEscrow();
     INBOX = IInbox(address(new Inbox(address(this), Constants.L1_TO_L2_MSG_SUBTREE_HEIGHT)));

l1-contracts/src/core/libraries/DataStructures.sol

@@ -67,18 +67,6 @@ library DataStructures {
   }
   // docs:end:l2_to_l1_msg
 
-  // docs:start:registry_snapshot
-  /**
-   * @notice Struct for storing address of cross communication components and the block number when it was updated
-   * @param rollup - The address of the rollup contract
-   * @param blockNumber - The block number of the snapshot
-   */
-  struct RegistrySnapshot {
-    address rollup;
-    uint256 blockNumber;
-  }
-  // docs:end:registry_snapshot
-
   /**
    * @notice Struct for storing flags for block header validation
    * @param ignoreDA - True will ignore DA check, otherwise checks

l1-contracts/src/core/libraries/Errors.sol

@@ -72,10 +72,6 @@ library Errors {
   error Rollup__TryingToProveNonExistingBlock(); // 0x34ef4954
   error Rollup__UnavailableTxs(bytes32 txsHash); // 0x414906c3
 
-  // Registry
-  error Registry__RollupNotRegistered(address rollup); // 0xa1fee4cf
-  error Registry__RollupAlreadyRegistered(address rollup); // 0x3c34eabf
-
   //TxsDecoder
   error TxsDecoder__InvalidLogsLength(uint256 expected, uint256 actual); // 0x829ca981
   error TxsDecoder__TxsTooLarge(uint256 expected, uint256 actual); // 0xc7d44a62

l1-contracts/src/core/messagebridge/Registry.sol → l1-contracts/src/governance/Registry.sol

@@ -2,11 +2,10 @@
 // Copyright 2023 Aztec Labs.
 pragma solidity >=0.8.27;
 
-import {IRegistry} from "@aztec/core/interfaces/messagebridge/IRegistry.sol";
-import {IRollup} from "@aztec/core/interfaces/IRollup.sol";
+import {IRegistry} from "@aztec/governance/interfaces/IRegistry.sol";
 
-import {DataStructures} from "@aztec/core/libraries/DataStructures.sol";
-import {Errors} from "@aztec/core/libraries/Errors.sol";
+import {DataStructures} from "@aztec/governance/libraries/DataStructures.sol";
+import {Errors} from "@aztec/governance/libraries/Errors.sol";
 
 import {Ownable} from "@oz/access/Ownable.sol";
 
@@ -29,11 +28,11 @@ contract Registry is IRegistry, Ownable {
   }
 
   /**
-   * @notice Returns the rollup contract
-   * @return The rollup contract (of type IRollup)
+   * @notice Returns the address of the rollup contract
+   * @return The rollup address
    */
-  function getRollup() external view override(IRegistry) returns (IRollup) {
-    return IRollup(currentSnapshot.rollup);
+  function getRollup() external view override(IRegistry) returns (address) {
+    return currentSnapshot.rollup;
   }
 
   /**
@@ -109,11 +108,13 @@ contract Registry is IRegistry, Ownable {
     snapshots[version] = newSnapshot;
     rollupToVersion[_rollup] = version;
 
+    emit InstanceAdded(_rollup, version);
+
     return version;
   }
 
   function _getVersionFor(address _rollup) internal view returns (uint256 version, bool exists) {
     version = rollupToVersion[_rollup];
-    return (version, version > 0);
+    return (version, version > 0 || snapshots[0].rollup == _rollup);
   }
 }

l1-contracts/src/core/interfaces/messagebridge/IRegistry.sol → l1-contracts/src/governance/interfaces/IRegistry.sol

@@ -1,16 +1,17 @@
 // SPDX-License-Identifier: Apache-2.0
 pragma solidity >=0.8.27;
 
-import {DataStructures} from "../../libraries/DataStructures.sol";
-import {IRollup} from "../IRollup.sol";
+import {DataStructures} from "@aztec/governance/libraries/DataStructures.sol";
 
 interface IRegistry {
+  event InstanceAdded(address indexed instance, uint256 indexed version);
+
   // docs:start:registry_upgrade
   function upgrade(address _rollup) external returns (uint256);
   // docs:end:registry_upgrade
 
   // docs:start:registry_get_rollup
-  function getRollup() external view returns (IRollup);
+  function getRollup() external view returns (address);
   // docs:end:registry_get_rollup
 
   // docs:start:registry_get_version_for

l1-contracts/src/governance/libraries/DataStructures.sol

@@ -0,0 +1,22 @@
+// SPDX-License-Identifier: Apache-2.0
+// Copyright 2023 Aztec Labs.
+pragma solidity >=0.8.18;
+
+/**
+ * @title Data Structures Library
+ * @author Aztec Labs
+ * @notice Library that contains data structures used throughout Aztec governance
+ */
+library DataStructures {
+  // docs:start:registry_snapshot
+  /**
+   * @notice Struct for storing address of cross communication components and the block number when it was updated
+   * @param rollup - The address of the rollup contract
+   * @param blockNumber - The block number of the snapshot
+   */
+  struct RegistrySnapshot {
+    address rollup;
+    uint256 blockNumber;
+  }
+  // docs:end:registry_snapshot
+}

l1-contracts/src/governance/libraries/Errors.sol

@@ -0,0 +1,16 @@
+// SPDX-License-Identifier: Apache-2.0
+// Copyright 2023 Aztec Labs.
+pragma solidity >=0.8.18;
+
+/**
+ * @title Errors Library
+ * @author Aztec Labs
+ * @notice Library that contains errors used throughout the Aztec governance
+ * Errors are prefixed with the contract name to make it easy to identify where the error originated
+ * when there are multiple contracts that could have thrown the error.
+ */
+library Errors {
+  // Registry
+  error Registry__RollupNotRegistered(address rollup); // 0xa1fee4cf
+  error Registry__RollupAlreadyRegistered(address rollup); // 0x3c34eabf
+}