Governance

Cargo.toml

@@ -7,6 +7,7 @@ members = [
 exclude = [
     "examples",
     "example_project_structure",
+    "mocks"
 ]
 
 [package]
@@ -67,6 +68,8 @@ timelock_controller = ["openbrush_contracts/timelock_controller"]
 proxy = ["openbrush_contracts/proxy"]
 diamond = ["openbrush_contracts/diamond"]
 upgradeable = ["openbrush_contracts/upgradeable"]
+governance = ["openbrush_contracts/governance"]
+utils = ["openbrush_contracts/utils"]
 
 test-all = [
     "psp22",
@@ -81,14 +84,15 @@ test-all = [
     "timelock_controller",
     "proxy",
     "diamond",
+    "governance",
+    "utils",
 ]
 
 [profile.release]
 panic = "abort"
 lto = false
 
 [profile.dev]
-
 panic = "abort"
 lto = false
 overflow-checks = false

Dockerfile

@@ -11,12 +11,12 @@ RUN npm install -g n && \
     npm install -g yarn && \
     n stable
 
-RUN curl -sSf https://sh.rustup.rs/ | sh
+RUN curl -sSf https://sh.rustup.rs/ -y | sh
 
 RUN rustup component add rust-src
 RUN rustup target add wasm32-unknown-unknown
 
 RUN cargo install cargo-dylint dylint-link
 
-RUN cargo install cargo-contract --version 3.2.0 --force && \
+RUN cargo install cargo-contract --version 4.0.0-alpha --force && \
     cargo install contracts-node --git https://github.com/paritytech/substrate-contracts-node.git --force --locked

LICENSE

@@ -1,3 +1,4 @@
+// Copyright (c) 2023 Brushfam
 // Copyright (c) 2012-2022 Supercolony
 //
 // Permission is hereby granted, free of charge, to any person obtaining

contracts/Cargo.toml

@@ -18,6 +18,7 @@ include = ["Cargo.toml", "src/**/*.rs"]
 ink = { version = "4.3.0", default-features = false}
 scale = { package = "parity-scale-codec", version = "3", default-features = false, features = ["derive"] }
 scale-info = { version = "2.6", default-features = false, features = ["derive"], optional = true }
+hex = { version = "0.4.3", default-features = false, features = ["alloc"] }
 
 openbrush = { version = "~4.0.0-beta.1", package = "openbrush_lang", path = "../lang", default-features = false }
 
@@ -57,6 +58,11 @@ proxy = [
 diamond = [
     "ownable",
 ]
+governance = [
+    "timelock_controller",
+    "utils"
+]
+utils = []
 upgradeable = ["ownable"]
 test-all = [
     "psp22",
@@ -69,5 +75,7 @@ test-all = [
     "pausable",
     "timelock_controller",
     "proxy",
+    "utils",
     "diamond",
+    "governance",
 ]

contracts/src/governance/extensions/governor_counting/data.rs

@@ -0,0 +1,41 @@
+// Copyright (c) 2023 Brushfam
+// Copyright (c) 2012-2022 Supercolony
+//
+// Permission is hereby granted, free of charge, to any person obtaining
+// a copy of this software and associated documentation files (the"Software"),
+// to deal in the Software without restriction, including
+// without limitation the rights to use, copy, modify, merge, publish,
+// distribute, sublicense, and/or sell copies of the Software, and to
+// permit persons to whom the Software is furnished to do so, subject to
+// the following conditions:
+//
+// The above copyright notice and this permission notice shall be
+// included in all copies or substantial portions of the Software.
+//
+// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+// EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+// MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+// NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+// LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+// OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+// WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+pub use crate::traits::governance::{
+    ProposalId,
+    ProposalVote,
+};
+pub use openbrush::{
+    storage::Mapping,
+    traits::AccountId,
+};
+
+#[derive(Default, Debug)]
+#[openbrush::storage_item]
+pub struct Data {
+    /// Stores the ammounts of the votes of the proposals
+    /// The key is the proposal id and the value is the vote, which contains the ammount of votes
+    pub proposal_votes: Mapping<ProposalId, ProposalVote>,
+
+    /// Stores if the account has voted for the proposal
+    pub has_votes: Mapping<(ProposalId, AccountId), ()>,
+}

contracts/src/governance/extensions/governor_counting/impls.rs

@@ -0,0 +1,49 @@
+// Copyright (c) 2023 Brushfam
+// Copyright (c) 2012-2022 Supercolony
+//
+// Permission is hereby granted, free of charge, to any person obtaining
+// a copy of this software and associated documentation files (the"Software"),
+// to deal in the Software without restriction, including
+// without limitation the rights to use, copy, modify, merge, publish,
+// distribute, sublicense, and/or sell copies of the Software, and to
+// permit persons to whom the Software is furnished to do so, subject to
+// the following conditions:
+//
+// The above copyright notice and this permission notice shall be
+// included in all copies or substantial portions of the Software.
+//
+// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+// EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+// MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+// NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+// LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+// OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+// WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+use crate::governance::extensions::governor_counting::{
+    CountingInternal,
+    Data,
+};
+pub use crate::{
+    governance::extensions::governor_counting,
+    traits::governance::extensions::governor_counting::*,
+};
+use openbrush::traits::{
+    AccountId,
+    Storage,
+};
+
+/// Extension of `Governor` for simple, 3 options, vote counting.
+pub trait GovernorCountingImpl: Storage<Data> + CountingInternal {
+    /// Returns `true` if the account has voted for the proposal, `false` otherwise
+    fn has_voted(&self, proposal_id: ProposalId, account: AccountId) -> bool {
+        self.data::<Data>().has_votes.get(&(proposal_id, account)).is_some()
+    }
+    /// Returns the tuple (for, against, abstain) votes for a proposal, where `for` is the total
+    /// number of votes for the proposal, `against` is the total number of votes against the
+    /// proposal, and `abstain` is the total number of abstained votes.
+    fn proposal_votes(&self, proposal_id: ProposalId) -> Result<ProposalVote, GovernanceError> {
+        let proposal_vote = self.data::<Data>().proposal_votes.get(&proposal_id).unwrap_or_default();
+        Ok(ProposalVote { ..proposal_vote })
+    }
+}

contracts/src/governance/extensions/governor_counting/internal.rs

@@ -0,0 +1,108 @@
+// Copyright (c) 2023 Brushfam
+// Copyright (c) 2012-2022 Supercolony
+//
+// Permission is hereby granted, free of charge, to any person obtaining
+// a copy of this software and associated documentation files (the"Software"),
+// to deal in the Software without restriction, including
+// without limitation the rights to use, copy, modify, merge, publish,
+// distribute, sublicense, and/or sell copies of the Software, and to
+// permit persons to whom the Software is furnished to do so, subject to
+// the following conditions:
+//
+// The above copyright notice and this permission notice shall be
+// included in all copies or substantial portions of the Software.
+//
+// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+// EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+// MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+// NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+// LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+// OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+// WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+use crate::{
+    governance::{
+        extensions::{
+            governor_counting::Data,
+            governor_quorum::QuorumImpl,
+        },
+        governor::GovernorStorageGetters,
+    },
+    traits::{
+        errors::GovernanceError,
+        governance::{
+            ProposalId,
+            VoteType,
+        },
+    },
+};
+use openbrush::traits::{
+    AccountId,
+    Balance,
+    Storage,
+};
+
+pub trait CountingInternal: Storage<Data> + QuorumImpl + GovernorStorageGetters {
+    /// Returns true if the quorum is reached for the given proposal, false otherwise
+    fn _quorum_reached(&self, proposal_id: ProposalId) -> Result<bool, GovernanceError> {
+        let proposal_vote = self.data::<Data>().proposal_votes.get(&proposal_id).unwrap_or_default();
+        let num_votes = proposal_vote
+            .for_votes
+            .checked_add(proposal_vote.abstain_votes)
+            .ok_or(GovernanceError::Overflow)?;
+
+        Ok(self.quorum(self._proposal_snapshot(proposal_id)?)? <= num_votes)
+    }
+
+    /// Returns true if the proposal has succeeded, false otherwise
+    fn _vote_succeeded(&self, proposal_id: ProposalId) -> bool {
+        self.data::<Data>()
+            .proposal_votes
+            .get(&proposal_id)
+            .map(|proposal_vote| proposal_vote.for_votes > proposal_vote.against_votes)
+            .unwrap_or_default()
+    }
+
+    /// Adds a `account`'s vote to `proposal_id` with `weight` votes, to the `support` side.
+    fn _count_vote(
+        &mut self,
+        proposal_id: ProposalId,
+        account: AccountId,
+        support: VoteType,
+        weight: Balance,
+        // params: Vec<u8>,
+    ) -> Result<(), GovernanceError> {
+        let mut proposal_vote = self.data::<Data>().proposal_votes.get(&proposal_id).unwrap_or_default();
+
+        if self.data::<Data>().has_votes.get(&(proposal_id, account)).is_some() {
+            return Err(GovernanceError::AlreadyCastVote(account))?
+        }
+
+        self.data::<Data>().has_votes.insert(&(proposal_id, account), &());
+
+        match support {
+            VoteType::Against => {
+                proposal_vote.against_votes = proposal_vote
+                    .against_votes
+                    .checked_add(weight)
+                    .ok_or(GovernanceError::Overflow)?;
+            }
+            VoteType::For => {
+                proposal_vote.for_votes = proposal_vote
+                    .for_votes
+                    .checked_add(weight)
+                    .ok_or(GovernanceError::Overflow)?;
+            }
+            VoteType::Abstain => {
+                proposal_vote.abstain_votes = proposal_vote
+                    .abstain_votes
+                    .checked_add(weight)
+                    .ok_or(GovernanceError::Overflow)?;
+            }
+        }
+
+        self.data::<Data>().proposal_votes.insert(&proposal_id, &proposal_vote);
+
+        Ok(())
+    }
+}

contracts/src/governance/extensions/governor_counting/mod.rs

@@ -0,0 +1,29 @@
+// Copyright (c) 2023 Brushfam
+// Copyright (c) 2012-2022 Supercolony
+//
+// Permission is hereby granted, free of charge, to any person obtaining
+// a copy of this software and associated documentation files (the"Software"),
+// to deal in the Software without restriction, including
+// without limitation the rights to use, copy, modify, merge, publish,
+// distribute, sublicense, and/or sell copies of the Software, and to
+// permit persons to whom the Software is furnished to do so, subject to
+// the following conditions:
+//
+// The above copyright notice and this permission notice shall be
+// included in all copies or substantial portions of the Software.
+//
+// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+// EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+// MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+// NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+// LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+// OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+// WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+mod data;
+mod impls;
+mod internal;
+
+pub use data::*;
+pub use impls::*;
+pub use internal::*;

contracts/src/governance/extensions/governor_quorum/data.rs

@@ -0,0 +1,31 @@
+// Copyright (c) 2023 Brushfam
+// Copyright (c) 2012-2022 Supercolony
+//
+// Permission is hereby granted, free of charge, to any person obtaining
+// a copy of this software and associated documentation files (the"Software"),
+// to deal in the Software without restriction, including
+// without limitation the rights to use, copy, modify, merge, publish,
+// distribute, sublicense, and/or sell copies of the Software, and to
+// permit persons to whom the Software is furnished to do so, subject to
+// the following conditions:
+//
+// The above copyright notice and this permission notice shall be
+// included in all copies or substantial portions of the Software.
+//
+// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+// EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+// MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+// NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+// LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+// OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+// WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+pub use crate::utils::checkpoint::Checkpoints;
+
+#[derive(Debug, Default)]
+#[openbrush::storage_item]
+pub struct Data {
+    /// Stores the quorum numerator history of the governor
+    #[lazy]
+    pub quorum_numerator_history: Checkpoints,
+}

contracts/src/governance/extensions/governor_quorum/events.rs

@@ -0,0 +1,29 @@
+// Copyright (c) 2023 Brushfam
+// Copyright (c) 2012-2022 Supercolony
+//
+// Permission is hereby granted, free of charge, to any person obtaining
+// a copy of this software and associated documentation files (the"Software"),
+// to deal in the Software without restriction, including
+// without limitation the rights to use, copy, modify, merge, publish,
+// distribute, sublicense, and/or sell copies of the Software, and to
+// permit persons to whom the Software is furnished to do so, subject to
+// the following conditions:
+//
+// The above copyright notice and this permission notice shall be
+// included in all copies or substantial portions of the Software.
+//
+// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+// EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+// MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+// NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+// LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+// OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+// WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+pub trait QuorumEvents {
+    /// Emitted when the quorum denominator is updated
+    fn emit_quorum_numerator_updated(&self, _old_quorum_numerator: u128, _new_quorum_numerator: u128) {}
+
+    /// Emitted when the governor quorum is invalid
+    fn emit_governor_invalid_quorum_fraction(&self, _quorum_numerator: u128, _quorum_denominator: u128) {}
+}