wip governance

dojoengine · Jul 24, 2024 · f8fae8c · f8fae8c
1 parent 5207ed7
commit f8fae8c
Show file tree

Hide file tree

Showing 40 changed files with 265 additions and 141 deletions.
diff --git a/Scarb.lock b/Scarb.lock
@@ -33,6 +33,13 @@ dependencies = [
  "cubit",
 ]
 
+[[package]]
+name = "origami_governance"
+version = "0.1.0"
+dependencies = [
+ "dojo",
+]
+
 [[package]]
 name = "origami_map"
 version = "0.1.0"

diff --git a/Scarb.toml b/Scarb.toml
@@ -1,16 +1,14 @@
 [workspace]
 members = [
-    # Scarb dependent crates.
     "crates/algebra",
     "crates/defi",
     "crates/map",
     "crates/random",
     "crates/rating",
     "crates/security",
-
-    # Sozo dependent crates.
     "crates/token",
-#    "governance"
+# WIP porting Governance to Cairo 2.7 and Dojo 1.0.0.
+#    "crates/governance"
 ]
 
 [workspace.dependencies]

diff --git a/crates/governance/Scarb.toml b/crates/governance/Scarb.toml
@@ -1,6 +1,6 @@
 [package]
-name = "governance"
-version = "0.0.0"
+name = "origami_governance"
+version = "0.1.0"
 description = "Implementations of Compound Governance standards for the Dojo framework."
 homepage = "https://github.com/dojoengine/origami/tree/governance"
 
@@ -12,4 +12,7 @@ sort-module-level-items = true
 
 [lib]
 
-[[target.dojo]]
+[tool.dojo.world]
+name = "governance"
+seed = "governance"
+namespace = { default = "origami_governance" }
diff --git a/crates/governance/src/libraries/events.cairo b/crates/governance/src/libraries/events.cairo
@@ -1,7 +1,8 @@
 mod tokenevents {
     use starknet::ContractAddress;
 
-    #[derive(Model, Copy, Drop, Serde)]
+    #[derive(Copy, Drop, Serde)]
+    #[dojo::model]
     #[dojo::event]
     struct DelegateChanged {
         #[key]
@@ -10,16 +11,18 @@ mod tokenevents {
         to: ContractAddress,
     }
 
-    #[derive(Model, Copy, Drop, Serde)]
+    #[derive(Copy, Drop, Serde)]
     #[dojo::event]
+    #[dojo::model]
     struct DelegateVotesChanged {
         #[key]
         delegatee: ContractAddress,
         prev_balance: u128,
         new_balance: u128,
     }
 
-    #[derive(Model, Copy, Drop, Serde)]
+    #[derive(Copy, Drop, Serde)]
+    #[dojo::model]
     #[dojo::event]
     struct Transfer {
         #[key]
@@ -28,7 +31,8 @@ mod tokenevents {
         amount: u128,
     }
 
-    #[derive(Model, Copy, Drop, Serde)]
+    #[derive(Copy, Drop, Serde)]
+    #[dojo::model]
     #[dojo::event]
     struct Approval {
         #[key]
@@ -41,68 +45,75 @@ mod tokenevents {
 mod timelockevents {
     use starknet::{ContractAddress, ClassHash};
 
-    #[derive(Model, Copy, Drop, Serde)]
+    #[derive(Copy, Drop, Serde)]
     #[dojo::event]
+    #[dojo::model]
     struct NewAdmin {
         #[key]
-        contract: ContractAddress,
+        contract_selector: felt252,
         address: ContractAddress,
     }
 
-    #[derive(Model, Copy, Drop, Serde)]
+    #[derive(Copy, Drop, Serde)]
     #[dojo::event]
+    #[dojo::model]
     struct NewDelay {
         #[key]
-        contract: ContractAddress,
+        contract_selector: felt252,
         value: u64,
     }
 
-    #[derive(Model, Copy, Drop, Serde)]
+    #[derive(Copy, Drop, Serde)]
     #[dojo::event]
+    #[dojo::model]
     struct CancelTransaction {
         #[key]
-        target: ContractAddress,
+        target_selector: felt252,
         class_hash: ClassHash,
         eta: u64,
     }
 
-    #[derive(Model, Copy, Drop, Serde)]
+    #[derive(Copy, Drop, Serde)]
     #[dojo::event]
+    #[dojo::model]
     struct ExecuteTransaction {
         #[key]
-        target: ContractAddress,
+        target_selector: felt252,
         class_hash: ClassHash,
         eta: u64,
     }
 
-    #[derive(Model, Copy, Drop, Serde)]
+    #[derive(Copy, Drop, Serde)]
     #[dojo::event]
+    #[dojo::model]
     struct QueueTransaction {
         #[key]
-        target: ContractAddress,
+        target_selector: felt252,
         class_hash: ClassHash,
         eta: u64,
     }
 }
 
 mod governorevents {
-    use governance::models::governor::Support;
+    use origami_governance::models::governor::Support;
     use starknet::{ContractAddress, ClassHash};
 
-    #[derive(Model, Copy, Drop, Serde)]
+    #[derive(Copy, Drop, Serde)]
     #[dojo::event]
+    #[dojo::model]
     struct ProposalCreated {
         #[key]
         id: usize,
         proposer: ContractAddress,
-        target: ContractAddress,
+        target_selector: felt252,
         class_hash: ClassHash,
         start_block: u64,
         end_block: u64,
     }
 
-    #[derive(Model, Copy, Drop, Serde)]
+    #[derive(Copy, Drop, Serde)]
     #[dojo::event]
+    #[dojo::model]
     struct VoteCast {
         #[key]
         voter: ContractAddress,
@@ -111,24 +122,27 @@ mod governorevents {
         votes: u128,
     }
 
-    #[derive(Model, Copy, Drop, Serde)]
+    #[derive(Copy, Drop, Serde)]
     #[dojo::event]
+    #[dojo::model]
     struct ProposalCanceled {
         #[key]
         id: usize,
         cancelled: bool,
     }
 
-    #[derive(Model, Copy, Drop, Serde)]
+    #[derive(Copy, Drop, Serde)]
     #[dojo::event]
+    #[dojo::model]
     struct ProposalQueued {
         #[key]
         id: usize,
         eta: u64,
     }
 
-    #[derive(Model, Copy, Drop, Serde)]
+    #[derive(Copy, Drop, Serde)]
     #[dojo::event]
+    #[dojo::model]
     struct ProposalExecuted {
         #[key]
         id: usize,

diff --git a/crates/governance/src/models/governor.cairo b/crates/governance/src/models/governor.cairo
@@ -1,11 +1,11 @@
-use governance::libraries::traits::{ContractAddressDefault, ClassHashDefault};
+use origami_governance::libraries::traits::{ContractAddressDefault, ClassHashDefault};
 use starknet::{ContractAddress, ClassHash};
 
 #[dojo::model]
 #[derive(Copy, Drop, Serde)]
 struct GovernorParams {
     #[key]
-    contract: ContractAddress,
+    contract_selector: felt252,
     timelock: ContractAddress,
     gov_token: ContractAddress,
     guardian: ContractAddress,
@@ -15,7 +15,7 @@ struct GovernorParams {
 #[derive(Copy, Drop, Serde)]
 struct ProposalParams {
     #[key]
-    contract: ContractAddress,
+    contract_selector: felt252,
     quorum_votes: u128,
     threshold: u128,
     voting_delay: u64,
@@ -26,7 +26,7 @@ struct ProposalParams {
 #[derive(Copy, Drop, Serde)]
 struct ProposalCount {
     #[key]
-    contract: ContractAddress,
+    contract_selector: felt252,
     count: usize,
 }
 
@@ -61,7 +61,7 @@ struct Proposal {
     id: usize,
     proposer: ContractAddress,
     eta: u64,
-    target: ContractAddress,
+    target_selector: felt252,
     class_hash: ClassHash,
     start_block: u64,
     end_block: u64,

diff --git a/crates/governance/src/models/timelock.cairo b/crates/governance/src/models/timelock.cairo
@@ -5,7 +5,7 @@ use starknet::{ContractAddress, ClassHash};
 #[derive(Copy, Drop, Serde)]
 struct TimelockParams {
     #[key]
-    contract: ContractAddress,
+    contract_selector: felt252,
     admin: ContractAddress,
     delay: u64,
 }
@@ -14,15 +14,15 @@ struct TimelockParams {
 #[derive(Copy, Drop, Serde)]
 struct PendingAdmin {
     #[key]
-    contract: ContractAddress,
+    contract_selector: felt252,
     address: ContractAddress,
 }
 
 #[dojo::model]
 #[derive(Copy, Drop, Serde)]
 struct QueuedTransactions {
     #[key]
-    contract: ContractAddress,
+    contract_selector: felt252,
     #[key]
     class_hash: ClassHash,
     queued: bool,