Governance v2.0.0

.solhintignore

@@ -5,6 +5,7 @@ node_modules/
 **/contracts/routers
 \*\*/typechain-types
 utils/core-contracts/contracts/utils/SafeCast
+storage.dump.sol
 
 # foundry lib
 \*\*/lib
@@ -16,5 +17,3 @@ utils/core-contracts/contracts/utils/SafeCast
 utils/core-modules/contracts/modules/UpgradeModule.sol
 utils/core-contracts/contracts/ownership/Ownable.sol
 utils/core-contracts/contracts/ownership/OwnableStorage.sol
-
-storage.dump.sol

protocol/governance/.gitignore

@@ -1,4 +1,2 @@
-contracts/Router.sol
-deployments/hardhat
-deployments/local
-deployments/localhost
+contracts/generated
+test/generated

protocol/governance/.solcover.js

@@ -1,4 +1,4 @@
 module.exports = {
   ...require('@synthetixio/common-config/.solcover.js'),
-  skipFiles: ['mocks', 'Router.sol'],
+  skipFiles: ['mocks', 'generated'],
 };

protocol/governance/cannonfile.satellite.test.toml

@@ -0,0 +1,6 @@
+name = "synthetix-governance"
+version = "<%= package.version %>-test-sat"
+include = ["cannonfile.satellite.toml", "tomls/ccip.test.toml"]
+
+[contract.SnapshotRecordMock]
+artifact = "contracts/mocks/SnapshotRecordMock.sol:SnapshotRecordMock"

protocol/governance/cannonfile.satellite.toml

@@ -0,0 +1,46 @@
+name = "synthetix-governance"
+description = "On-chain voting for synthetix councils - Logic for satellite chains"
+version = "<%= package.version %>"
+preset = "satellite"
+include = ["./tomls/proxy-base.toml", "./tomls/council-token.toml"]
+
+[setting.initial_epoch_index]
+defaultValue = "0"
+
+[contract.AssociatedSystemsModule]
+artifact = "contracts/modules/core/AssociatedSystemsModule.sol:AssociatedSystemsModule"
+
+[contract.CrossChainModule]
+artifact = "contracts/modules/core/CrossChainModule.sol:CrossChainModule"
+
+[contract.ElectionModuleSatellite]
+artifact = "contracts/modules/core/ElectionModuleSatellite.sol:ElectionModuleSatellite"
+
+[contract.CouncilTokenModule]
+artifact = "contracts/modules/council-nft/CouncilTokenModule.sol:CouncilTokenModule"
+
+[contract.SnapshotVotePowerModule]
+artifact = "contracts/modules/core/SnapshotVotePowerModule.sol:SnapshotVotePowerModule"
+
+[contract.CcipReceiverModule]
+artifact = "contracts/modules/core/CcipReceiverModule.sol:CcipReceiverModule"
+
+[router.CoreRouter]
+contracts = [
+    "AssociatedSystemsModule",
+    "CrossChainModule",
+    "ElectionModuleSatellite",
+    "SnapshotVotePowerModule",
+    "InitialModuleBundle",
+    "CcipReceiverModule",
+    "CouncilTokenModule"
+]
+
+[invoke.upgrade_core_proxy]
+target = ["InitialProxy"]
+from = "<%= settings.owner %>"
+func = "upgradeTo"
+args = ["<%= contracts.CoreRouter.address %>"]
+factory.CoreProxy.abiOf = ["CoreRouter"]
+factory.CoreProxy.event = "Upgraded"
+factory.CoreProxy.arg = 0

protocol/governance/cannonfile.test.toml

@@ -0,0 +1,48 @@
+name = "synthetix-governance"
+version = "<%= package.version %>-testable"
+include = ["cannonfile.toml", "tomls/ccip.test.toml"]
+
+[contract.SnapshotRecordMock]
+artifact = "contracts/mocks/SnapshotRecordMock.sol:SnapshotRecordMock"
+
+# Testable storage contracts
+[contract.TestableCouncilStorage]
+artifact = "contracts/generated/test/TestableCouncilStorage.sol:TestableCouncilStorage"
+
+[contract.TestableBallotStorage]
+artifact = "contracts/generated/test/TestableBallotStorage.sol:TestableBallotStorage"
+
+[contract.TestableSnapshotVotePowerStorage]
+artifact = "contracts/generated/test/TestableSnapshotVotePowerStorage.sol:TestableSnapshotVotePowerStorage"
+
+[contract.TestableElectionSettingsStorage]
+artifact = "contracts/generated/test/TestableElectionSettingsStorage.sol:TestableElectionSettingsStorage"
+
+[contract.TestableElectionStorage]
+artifact = "contracts/generated/test/TestableElectionStorage.sol:TestableElectionStorage"
+
+[contract.TestableEpochStorage]
+artifact = "contracts/generated/test/TestableEpochStorage.sol:TestableEpochStorage"
+
+# Core Router + Testable modules
+[router.TestRouter]
+contracts = [
+    # Extend Original Core Router
+    "CoreRouter",
+    # Testable storage contracts
+    "TestableCouncilStorage",
+    "TestableBallotStorage",
+    "TestableSnapshotVotePowerStorage",
+    "TestableElectionSettingsStorage",
+    "TestableElectionStorage",
+    "TestableEpochStorage"
+]
+
+[invoke.upgrade_core_proxy]
+target = ["InitialProxy"]
+from = "<%= settings.owner %>"
+func = "upgradeTo"
+args = ["<%= contracts.TestRouter.address %>"]
+factory.CoreProxy.abiOf = ["TestRouter"]
+factory.CoreProxy.event = "Upgraded"
+factory.CoreProxy.arg = 0

protocol/governance/cannonfile.toml

@@ -1,63 +1,58 @@
 name = "synthetix-governance"
 description = "On-chain voting for synthetix councils"
 version = "<%= package.version %>"
+preset = "main"
+include = ["./tomls/proxy-base.toml", "./tomls/council-token.toml"]
 
-[setting.salt]
-defaultValue = "governance"
-
-# Deployment Owner, defaults to first hardhat account
-[setting.owner]
+[setting.initial_council_member]
 defaultValue = "0xf39fd6e51aad88f6f4ce6ab8827279cfffb92266"
 
-[setting.council_token_name]
-defaultValue = "Synthetix Governance Module"
-
-[setting.council_token_symbol]
-defaultValue = "SNXGOV"
+[setting.minimum_active_members]
+defaultValue = "1"
 
-[setting.init_council_member]
-defaultValue = "0xf39fd6e51aad88f6f4ce6ab8827279cfffb92266" # can only specify 1
+[setting.initial_nomination_period_start_date]
+defaultValue = "0" # defaults to "block.timestamp + administration_period_duration" when given "0"
 
-[setting.epoch_start]
+[setting.administration_period_duration]
+defaultValue = "60" # days
 
-[setting.epoch_duration]
-defaultValue = "90" # days
+[setting.nomination_period_duration]
+defaultValue = "15" # days
 
 [setting.voting_period_duration]
-defaultValue = "7" # days
-
-[contract.InitialModuleBundle]
-artifact = "InitialModuleBundle"
-create2 = true
-
-[contract.InitialProxy]
-artifact = "contracts/Proxy.sol:Proxy"
-args = ["<%= contracts.InitialModuleBundle.address %>", "<%= settings.owner %>"]
-salt = "<%= settings.salt %>"
-abiOf = ["InitialModuleBundle"]
-create2 = true
+defaultValue = "15" # days
 
 [contract.AssociatedSystemsModule]
 artifact = "contracts/modules/core/AssociatedSystemsModule.sol:AssociatedSystemsModule"
 
-[contract.ElectionModule]
-artifact = "ElectionModule"
+[contract.CrossChainModule]
+artifact = "contracts/modules/core/CrossChainModule.sol:CrossChainModule"
 
 [contract.ElectionInspectorModule]
-artifact = "ElectionInspectorModule"
+artifact = "contracts/modules/core/ElectionInspectorModule.sol:ElectionInspectorModule"
+
+[contract.ElectionModule]
+artifact = "contracts/modules/core/ElectionModule.sol:ElectionModule"
+
+[contract.SnapshotVotePowerModule]
+artifact = "contracts/modules/core/SnapshotVotePowerModule.sol:SnapshotVotePowerModule"
 
 [contract.CouncilTokenModule]
-artifact = "CouncilTokenModule"
+artifact = "contracts/modules/council-nft/CouncilTokenModule.sol:CouncilTokenModule"
 
-[contract.DebtShareMock]
-artifact = "DebtShareMock"
+[contract.CcipReceiverModule]
+artifact = "contracts/modules/core/CcipReceiverModule.sol:CcipReceiverModule"
 
 [router.CoreRouter]
 contracts = [
     "AssociatedSystemsModule",
-    "ElectionModule",
+    "CrossChainModule",
     "ElectionInspectorModule",
+    "ElectionModule",
+    "SnapshotVotePowerModule",
     "InitialModuleBundle",
+    "CcipReceiverModule",
+    "CouncilTokenModule"
 ]
 
 [invoke.upgrade_core_proxy]
@@ -69,37 +64,15 @@ factory.CoreProxy.abiOf = ["CoreRouter"]
 factory.CoreProxy.event = "Upgraded"
 factory.CoreProxy.arg = 0
 
-[router.CouncilTokenRouter]
-contracts = ["CouncilTokenModule", "InitialModuleBundle"]
-
-[invoke.init_council_token]
-target = ["CoreProxy"]
-from = "<%= settings.owner %>"
-func = "initOrUpgradeNft"
-args = [
-    "<%= formatBytes32String('councilToken') %>",
-    "Synthetix Governance Token",
-    "SNXGOV",
-    "https://synthetix.io",
-    "<%= contracts.CouncilTokenRouter.address %>"
-]
-depends = ["invoke.upgrade_core_proxy", "router.CouncilTokenRouter"]
-factory.AccountProxy.abiOf = ["CouncilTokenRouter"]
-factory.AccountProxy.event = "AssociatedSystemSet"
-factory.AccountProxy.arg = 2
-
 [invoke.init_election_module]
 target = ["CoreProxy"]
-func = "initOrUpgradeElectionModule(address[],uint8,uint64,uint64,uint64,address)"
+func = "initOrUpdateElectionSettings(address[],uint8,uint64,uint64,uint64,uint64)"
 args = [
-    ["<%= settings.init_council_member %>"],
-    "1",
-    "<%= settings.epoch_start %>",
-    "<%= settings.epoch_start + 86400 * settings.voting_period_duration %>",
-    "<%= settings.epoch_start + 86400 * settings.epoch_duration %>",
-    "<%= contracts.DebtShareMock.address %>",
+    ["<%= settings.initial_council_member %>"],
+    "<%= settings.minimum_active_members %>",
+    "<%= settings.initial_nomination_period_start_date %>",
+    "<%= settings.administration_period_duration %>",
+    "<%= settings.nomination_period_duration %>",
+    "<%= settings.voting_period_duration %>",
 ]
 from = "<%= settings.owner %>"
-
-[provision.trusted_multicall_forwarder]
-source = "trusted-multicall-forwarder"

protocol/governance/contracts/Proxy.sol

@@ -4,9 +4,8 @@ pragma solidity >=0.8.11 <0.9.0;
 import {UUPSProxyWithOwner} from "@synthetixio/core-contracts/contracts/proxy/UUPSProxyWithOwner.sol";
 
 contract Proxy is UUPSProxyWithOwner {
-    // solhint-disable-next-line no-empty-blocks
     constructor(
         address firstImplementation,
         address initialOwner
-    ) UUPSProxyWithOwner(firstImplementation, initialOwner) {}
+    ) UUPSProxyWithOwner(firstImplementation, initialOwner) {} // solhint-disable-line no-empty-blocks
 }

protocol/governance/contracts/interfaces/ICouncilTokenModule.sol

@@ -1,7 +1,7 @@
 //SPDX-License-Identifier: MIT
 pragma solidity >=0.8.11 <0.9.0;
 
-import "@synthetixio/core-modules/contracts/interfaces/INftModule.sol";
+import {INftModule} from "@synthetixio/core-modules/contracts/interfaces/INftModule.sol";
 
 /**
  * @title Module with custom NFT logic for the account token.

protocol/governance/contracts/interfaces/IElectionInspectorModule.sol

@@ -26,22 +26,13 @@ interface IElectionInspectorModule {
     /// @notice Returns a list of all nominated candidates in the given epoch
     function getNomineesAtEpoch(uint epochIndex) external view returns (address[] memory);
 
-    /// @notice Returns the ballot id that user voted on in the given election
-    function getBallotVotedAtEpoch(address user, uint epochIndex) external view returns (bytes32);
-
     /// @notice Returns if user has voted in the given election
-    function hasVotedInEpoch(address user, uint epochIndex) external view returns (bool);
-
-    /// @notice Returns the number of votes given to a particular ballot in a given epoch
-    function getBallotVotesInEpoch(bytes32 ballotId, uint epochIndex) external view returns (uint);
-
-    /// @notice Returns the list of candidates that a particular ballot has in a given epoch
-    function getBallotCandidatesInEpoch(
-        bytes32 ballotId,
+    function hasVotedInEpoch(
+        address user,
+        uint chainId,
         uint epochIndex
-    ) external view returns (address[] memory);
+    ) external view returns (bool);
 
-    /// @notice Returns the number of votes a candidate received in a given epoch
     function getCandidateVotesInEpoch(
         address candidate,
         uint epochIndex