Compound like Governance Contracts

Scarb.lock

@@ -26,6 +26,13 @@ name = "dojo_plugin"
 version = "0.3.11"
 source = "git+https://github.com/dojoengine/dojo?tag=v0.3.11#1e651b5d4d3b79b14a7d8aa29a92062fcb9e6659"
 
+[[package]]
+name = "governance"
+version = "0.0.0"
+dependencies = [
+ "dojo",
+]
+
 [[package]]
 name = "hex_map"
 version = "0.0.0"

Scarb.toml

@@ -6,6 +6,7 @@ members = [
     "examples/market",
     "examples/projectile",
     "token",
+    "governance"
 ]
 
 [workspace.package]

governance/Scarb.lock

@@ -0,0 +1,16 @@
+# Code generated by scarb DO NOT EDIT.
+version = 1
+
+[[package]]
+name = "dojo"
+version = "0.6.0"
+source = "git+https://github.com/dojoengine/dojo?tag=v0.6.0#fc5ad790c1993713e59f3fc65739160f132f29f0"
+dependencies = [
+ "dojo_plugin",
+]
+
+[[package]]
+name = "dojo_plugin"
+version = "0.3.11"
+source = "git+https://github.com/dojoengine/dojo?tag=v0.3.11#1e651b5d4d3b79b14a7d8aa29a92062fcb9e6659"
+

governance/Scarb.toml

@@ -0,0 +1,15 @@
+[package]
+name = "governance"
+version = "0.0.0"
+description = "Implementations of Compound Governance standards for the Dojo framework."
+homepage = "https://github.com/dojoengine/origami/tree/governance"
+
+[dependencies]
+dojo.workspace = true
+
+[tool.fmt]
+sort-module-level-items = true
+
+[lib]
+
+[[target.dojo]]

governance/scripts/default_auth.sh

@@ -0,0 +1,23 @@
+#!/bin/bash
+set -euo pipefail
+pushd $(dirname "$0")/..
+
+export RPC_URL="http://localhost:5050"
+
+export WORLD_ADDRESS=$(cat ./manifests/deployments/KATANA.json | jq -r '.world.address')
+
+export ACTIONS_ADDRESS=$(cat ./manifests/deployments/KATANA.json | jq -r '.contracts[] | select(.name == "dojo_starter::systems::actions::actions" ).address')
+
+echo "---------------------------------------------------------------------------"
+echo world : $WORLD_ADDRESS
+echo " "
+echo actions : $ACTIONS_ADDRESS
+echo "---------------------------------------------------------------------------"
+
+# enable system -> models authorizations
+sozo auth grant --world $WORLD_ADDRESS --wait writer \
+  Position,$ACTIONS_ADDRESS \
+  Moves,$ACTIONS_ADDRESS \
+  >/dev/null
+
+echo "Default authorizations have been successfully set."

governance/scripts/spawn.sh

@@ -0,0 +1,12 @@
+#!/bin/bash
+set -euo pipefail
+pushd $(dirname "$0")/..
+
+export RPC_URL="http://localhost:5050";
+
+export WORLD_ADDRESS=$(cat ./manifests/deployments/KATANA.json | jq -r '.world.address')
+
+export ACTIONS_ADDRESS=$(cat ./manifests/deployments/KATANA.json | jq -r '.contracts[] | select(.name == "dojo_starter::systems::actions::actions" ).address')
+
+# sozo execute --world <WORLD_ADDRESS> <CONTRACT> <ENTRYPOINT>
+sozo execute --world $WORLD_ADDRESS $ACTIONS_ADDRESS spawn --wait

governance/src/lib.cairo

@@ -0,0 +1,28 @@
+mod libraries {
+    mod events;
+}
+
+mod models {
+    mod delegate;
+    mod delegator;
+    mod token;
+}
+
+mod systems {
+    mod delegate {
+        mod contract;
+        mod interface;
+        mod tests;
+    }
+    mod delegator {
+        mod contract;
+        mod interface;
+        mod tests;
+    }
+    mod token {
+        mod contract;
+        mod interface;
+        mod tests;
+    }
+}
+

governance/src/libraries/events.cairo

@@ -0,0 +1,39 @@
+mod tokenevents {
+    use starknet::ContractAddress;
+
+    #[derive(Model, Copy, Drop, Serde)]
+    #[dojo::event]
+    struct DelegateChanged {
+        #[key]
+        delegator: ContractAddress,
+        from_delegate: ContractAddress,
+        to_delegate: ContractAddress,
+    }
+
+    #[derive(Model, Copy, Drop, Serde)]
+    #[dojo::event]
+    struct DelegateVotesChanged {
+        #[key]
+        delegate: ContractAddress,
+        previous_balance: u128,
+        new_balance: u128,
+    }
+
+    #[derive(Model, Copy, Drop, Serde)]
+    #[dojo::event]
+    struct Transfer {
+        #[key]
+        from: ContractAddress,
+        to: ContractAddress,
+        amount: u128,
+    }
+
+    #[derive(Model, Copy, Drop, Serde)]
+    #[dojo::event]
+    struct Approval {
+        #[key]
+        owner: ContractAddress,
+        spender: ContractAddress,
+        amount: u128,
+    }
+}

governance/src/models/delegate.cairo

@@ -0,0 +1 @@
+

governance/src/models/delegator.cairo

@@ -0,0 +1 @@
+

governance/src/models/token.cairo

@@ -0,0 +1,69 @@
+use starknet::ContractAddress;
+
+#[derive(Model, Copy, Drop, Serde)]
+struct Metadata {
+    #[key]
+    token: ContractAddress,
+    name: felt252,
+    symbol: felt252,
+    decimals: u8,
+}
+
+#[derive(Model, Copy, Drop, Serde)]
+struct TotalSupply {
+    #[key]
+    token: ContractAddress,
+    amount: u128,
+}
+
+#[derive(Model, Copy, Drop, Serde)]
+struct Allowances {
+    #[key]
+    delegator: ContractAddress,
+    #[key]
+    delegate: ContractAddress,
+    amount: u128,
+}
+
+#[derive(Model, Copy, Drop, Serde)]
+struct Balances {
+    #[key]
+    account: ContractAddress,
+    amount: u128,
+}
+
+#[derive(Model, Copy, Drop, Serde)]
+struct Delegates {
+    #[key]
+    account: ContractAddress,
+    delegate: ContractAddress,
+}
+
+#[derive(Model, Copy, Drop, Serde)]
+struct Checkpoints {
+    #[key]
+    account: ContractAddress,
+    #[key]
+    index: u128,
+    checkpoint: Checkpoint,
+}
+
+#[derive(Model, Copy, Drop, Serde)]
+struct NumCheckpoints {
+    #[key]
+    account: ContractAddress,
+    count: u128,
+}
+
+#[derive(Model, Copy, Drop, Serde)]
+struct Nonces {
+    #[key]
+    account: ContractAddress,
+    nonce: usize,
+}
+
+#[derive(Copy, Drop, Introspect, Serde)]
+struct Checkpoint {
+    from_block: u64,
+    votes: u128,
+}

governance/src/systems/delegate/contract.cairo

@@ -0,0 +1 @@
+

governance/src/systems/delegate/interface.cairo

@@ -0,0 +1 @@
+

governance/src/systems/delegate/tests.cairo

@@ -0,0 +1 @@
+

governance/src/systems/delegator/contract.cairo

@@ -0,0 +1 @@
+

governance/src/systems/delegator/interface.cairo

@@ -0,0 +1 @@
+

governance/src/systems/delegator/tests.cairo

@@ -0,0 +1 @@
+

governance/src/systems/token/interface.cairo

@@ -0,0 +1,21 @@
+use starknet::ContractAddress;
+
+#[dojo::interface]
+trait IGovernanceToken {
+    fn spaw(
+        name: felt252,
+        symbol: felt252,
+        decimals: u8,
+        initial_supply: u128,
+        recipient: ContractAddress
+    );
+    fn approve(spender: ContractAddress, amount: u128);
+    fn transfer(to: ContractAddress, amount: u128);
+    fn transfer_from(from: ContractAddress, to: ContractAddress, amount: u128);
+    fn delegate(delegatee: ContractAddress);
+    fn delegate_by_signature(
+        delegatee: ContractAddress, nonce: usize, expiry: u64, pk: felt252, r: felt252, s: felt252
+    );
+    fn get_current_votes(account: ContractAddress) -> u128;
+    fn get_prior_votes(account: ContractAddress, block_number: u64) -> u128;
+}

governance/src/systems/token/tests.cairo

@@ -0,0 +1 @@
+