Implement PauseDAO, closes #146

README.md

@@ -1,13 +1,13 @@
 # DAO DAO Contracts
 
-| Contract                                     | Description                                                        |
-| :------------------------------------------- | :------------------------------------------------------------------|
-| [cw-distribution](contracts/cw-distribution) | A contract for distributing staking rewards.                       |
-| [cw3-dao](contracts/cw3-dao)                 | A DAO with voting power based on staked governance tokens.         |
-| [cw3-multisig](contracts/cw3-multisig)       | A multisig contract.                                               |
-| [cw4-registry](contracts/cw4-registry)       | A contract for indexing multisig group members.                    |
-| [stake-cw20](contracts/stake-cw20)           | A cw20 staking contract.                                           |
-| [stake-cw20-gov](contracts/stake-cw20-gov)   | A cw20 staking contract, with vote delegation (used by `cw3-dao`). |
+| Contract                                     | Description                                                |
+| :------------------------------------------- | :--------------------------------------------------------- |
+| [cw-distribution](contracts/cw-distribution) | A contract for distributing staking rewards.               |
+| [cw3-dao](contracts/cw3-dao)                 | A DAO with voting power based on staked governance tokens. |
+| [cw3-multisig](contracts/cw3-multisig)       | A multisig contract.                                       |
+| [cw4-registry](contracts/cw4-registry)       | A contract for indexing multisig group members.            |
+| [stake-cw20](contracts/stake-cw20)           | A cw20 staking contract.                                   |
+| [stake-cw20-gov](contracts/stake-cw20-gov)   | A cw20 staking contract, with vote delegation.             |
 
 NOTE: _These contracts have yet to be audited. Please see the [disclaimer](#Disclaimer)._
 

contracts/cw3-dao/schema/execute_msg.json

@@ -74,6 +74,27 @@
       },
       "additionalProperties": false
     },
+    {
+      "description": "Pauses DAO governance (can only be called by DAO contract)",
+      "type": "object",
+      "required": [
+        "pause_d_a_o"
+      ],
+      "properties": {
+        "pause_d_a_o": {
+          "type": "object",
+          "required": [
+            "expiration"
+          ],
+          "properties": {
+            "expiration": {
+              "$ref": "#/definitions/Expiration"
+            }
+          }
+        }
+      },
+      "additionalProperties": false
+    },
     {
       "description": "Update DAO config (can only be called by DAO contract)",
       "type": "object",
@@ -117,6 +138,27 @@
         }
       },
       "additionalProperties": false
+    },
+    {
+      "description": "Update Staking Contract (can only be called by DAO contract) WARNING: this changes the contract controlling voting",
+      "type": "object",
+      "required": [
+        "update_staking_contract"
+      ],
+      "properties": {
+        "update_staking_contract": {
+          "type": "object",
+          "required": [
+            "new_staking_contract"
+          ],
+          "properties": {
+            "new_staking_contract": {
+              "$ref": "#/definitions/Addr"
+            }
+          }
+        }
+      },
+      "additionalProperties": false
     }
   ],
   "definitions": {

contracts/cw3-dao/src/contract.rs

@@ -10,7 +10,7 @@ use crate::query::{
     VoteTallyResponse, VoterResponse,
 };
 use crate::state::{
-    next_id, Ballot, Config, Proposal, Votes, BALLOTS, CONFIG, GOV_TOKEN, PROPOSALS,
+    next_id, Ballot, Config, Proposal, Votes, BALLOTS, CONFIG, DAO_PAUSED, GOV_TOKEN, PROPOSALS,
     STAKING_CONTRACT, STAKING_CONTRACT_CODE_ID, STAKING_CONTRACT_UNSTAKING_DURATION,
     TREASURY_TOKENS,
 };
@@ -174,6 +174,7 @@ pub fn execute(
         }
         ExecuteMsg::Execute { proposal_id } => execute_execute(deps, env, info, proposal_id),
         ExecuteMsg::Close { proposal_id } => execute_close(deps, env, info, proposal_id),
+        ExecuteMsg::PauseDAO { expiration } => execute_pause_dao(deps, env, info, expiration),
         ExecuteMsg::UpdateConfig(config) => execute_update_config(deps, env, info, config),
         ExecuteMsg::UpdateCw20TokenList { to_add, to_remove } => {
             execute_update_cw20_token_list(deps, env, info, to_add, to_remove)
@@ -194,6 +195,14 @@ pub fn execute_propose(
     // we ignore earliest
     latest: Option<Expiration>,
 ) -> Result<Response<Empty>, ContractError> {
+    // Check if DAO is Paused
+    let paused = DAO_PAUSED.may_load(deps.storage)?;
+    if let Some(expiration) = paused {
+        if !expiration.is_expired(&env.block) {
+            return Err(ContractError::Paused {});
+        }
+    }
+
     let cfg = CONFIG.load(deps.storage)?;
     let gov_token = GOV_TOKEN.load(deps.storage)?;
 
@@ -367,6 +376,24 @@ pub fn execute_close(
         .add_attribute("proposal_id", proposal_id.to_string()))
 }
 
+pub fn execute_pause_dao(
+    deps: DepsMut,
+    env: Env,
+    info: MessageInfo,
+    expiration: Expiration,
+) -> Result<Response<Empty>, ContractError> {
+    // Only contract can call this method
+    if env.contract.address != info.sender {
+        return Err(ContractError::Unauthorized {});
+    }
+
+    DAO_PAUSED.save(deps.storage, &expiration)?;
+
+    Ok(Response::new()
+        .add_attribute("action", "pause_dao")
+        .add_attribute("expiration", expiration.to_string()))
+}
+
 pub fn execute_update_config(
     deps: DepsMut,
     env: Env,

contracts/cw3-dao/src/error.rs

@@ -39,7 +39,7 @@ pub enum ContractError {
     #[error("Already voted on this proposal")]
     AlreadyVoted {},
 
-    #[error("Proposal must have passed and not yet been executed")]
+    #[error("Cannot execute completed or unpassed proposals")]
     WrongExecuteStatus {},
 
     #[error("Cannot close completed or passed proposals")]
@@ -50,4 +50,7 @@ pub enum ContractError {
 
     #[error("Request size ({size}) is above limit of ({max})")]
     OversizedRequest { size: u64, max: u64 },
+
+    #[error("DAO is paused")]
+    Paused {},
 }

contracts/cw3-dao/src/helpers.rs

@@ -90,7 +90,7 @@ pub fn get_voting_power_at_height(deps: Deps, address: Addr, height: u64) -> Std
     // Get voting power at height
     let balance: VotingPowerAtHeightResponse = deps.querier.query_wasm_smart(
         staking_contract,
-        &StakingContractQueryMsg::VotingPowerAtHeight {
+        &StakingContractQueryMsg::StakedBalanceAtHeight {
             address: address.to_string(),
             height: Some(height),
         },

contracts/cw3-dao/src/msg.rs

@@ -155,6 +155,8 @@ pub enum ExecuteMsg {
     Execute { proposal_id: u64 },
     /// Close a failed proposal
     Close { proposal_id: u64 },
+    /// Pauses DAO governance (can only be called by DAO contract)
+    PauseDAO { expiration: Expiration },
     /// Update DAO config (can only be called by DAO contract)
     UpdateConfig(Config),
     /// Updates token list

contracts/cw3-dao/src/state.rs

@@ -150,6 +150,7 @@ pub struct Ballot {
 // Unique items
 pub const CONFIG: Item<Config> = Item::new("config");
 pub const PROPOSAL_COUNT: Item<u64> = Item::new("proposal_count");
+pub const DAO_PAUSED: Item<Expiration> = Item::new("dao_paused");
 
 // Total weight and voters are queried from this contract
 pub const STAKING_CONTRACT: Item<Addr> = Item::new("staking_contract");

contracts/cw3-dao/src/tests.rs

@@ -1858,6 +1858,91 @@ fn test_update_staking_contract() {
     )
 }
 
+#[test]
+fn test_pause_dao() {
+    let mut app = mock_app();
+
+    let voting_period = Duration::Time(2000000);
+    let threshold = Threshold::ThresholdQuorum {
+        threshold: Decimal::percent(20),
+        quorum: Decimal::percent(10),
+    };
+    let (dao_addr, _cw20_addr, _staking_addr) = setup_test_case(
+        &mut app,
+        threshold,
+        voting_period,
+        coins(100, NATIVE_TOKEN_DENOM),
+        None,
+        None,
+    );
+
+    // Pause DAO until height
+    const PAUSE_HEIGHT: u64 = 100000000;
+    let pause_dao_msg = ExecuteMsg::PauseDAO {
+        expiration: Expiration::AtHeight(PAUSE_HEIGHT),
+    };
+
+    // Nobody can call call update staking contract method directly
+    let res = app.execute_contract(
+        Addr::unchecked(VOTER1),
+        dao_addr.clone(),
+        &pause_dao_msg,
+        &[],
+    );
+    assert!(res.is_err());
+    let res = app.execute_contract(
+        Addr::unchecked(OWNER),
+        dao_addr.clone(),
+        &pause_dao_msg,
+        &[],
+    );
+    assert!(res.is_err());
+
+    let wasm_msg = WasmMsg::Execute {
+        contract_addr: dao_addr.clone().into(),
+        msg: to_binary(&pause_dao_msg).unwrap(),
+        funds: vec![],
+    };
+
+    // Pause DAO proposal must be made
+    let proposal_msg = ExecuteMsg::Propose(ProposeMsg {
+        title: String::from("Change params"),
+        description: String::from("Updates threshold and max voting params"),
+        msgs: vec![wasm_msg.into()],
+        latest: None,
+    });
+    let res = app
+        .execute_contract(Addr::unchecked(OWNER), dao_addr.clone(), &proposal_msg, &[])
+        .unwrap();
+    let proposal_id: u64 = res.custom_attrs(1)[2].value.parse().unwrap();
+
+    // Imediately passes on yes vote
+    let yes_vote = ExecuteMsg::Vote(VoteMsg {
+        proposal_id,
+        vote: Vote::Yes,
+    });
+    let res = app.execute_contract(Addr::unchecked(VOTER3), dao_addr.clone(), &yes_vote, &[]);
+    assert!(res.is_ok());
+
+    // Execute
+    let execution = ExecuteMsg::Execute { proposal_id };
+    let res = app.execute_contract(Addr::unchecked(OWNER), dao_addr.clone(), &execution, &[]);
+    assert!(res.is_ok());
+
+    // Check that DAO is paused, Propose should fail
+    let res = app
+        .execute_contract(Addr::unchecked(OWNER), dao_addr.clone(), &proposal_msg, &[])
+        .unwrap_err();
+    assert_eq!(res.to_string(), ContractError::Paused {}.to_string());
+
+    // Pause expiration height is reached
+    app.update_block(|b| b.height = PAUSE_HEIGHT + 1);
+
+    // Propose succeeds
+    let res = app.execute_contract(Addr::unchecked(OWNER), dao_addr, &proposal_msg, &[]);
+    assert!(res.is_ok());
+}
+
 #[test]
 fn test_config_query() {
     let mut app = mock_app();

types/contracts/cw3-dao/execute_msg.d.ts

@@ -15,13 +15,23 @@ proposal_id: number
 [k: string]: unknown
 }
 } | {
+pause_d_a_o: {
+expiration: Expiration
+[k: string]: unknown
+}
+} | {
 update_config: Config
 } | {
 update_cw20_token_list: {
 to_add: Addr[]
 to_remove: Addr[]
 [k: string]: unknown
 }
+} | {
+update_staking_contract: {
+new_staking_contract: Addr
+[k: string]: unknown
+}
 })
 
 export interface ProposeMsg {

types/contracts/stake-cw20-gov/execute_msg.d.ts

@@ -16,6 +16,30 @@ delegate_votes: {
 recipient: string
 [k: string]: unknown
 }
+} | {
+update_config: {
+admin: Addr
+duration?: (Duration | null)
+[k: string]: unknown
+}
+})
+/**
+ * A human readable address.
+ * 
+ * In Cosmos, this is typically bech32 encoded. But for multi-chain smart contracts no assumptions should be made other than being UTF-8 encoded and of reasonable length.
+ * 
+ * This type represents a validated address. It can be created in the following ways 1. Use `Addr::unchecked(input)` 2. Use `let checked: Addr = deps.api.addr_validate(input)?` 3. Use `let checked: Addr = deps.api.addr_humanize(canonical_addr)?` 4. Deserialize from JSON. This must only be done from JSON that was validated before such as a contract's state. `Addr` must not be used in messages sent by the user because this would result in unvalidated instances.
+ * 
+ * This type is immutable. If you really need to mutate it (Really? Are you sure?), create a mutable copy using `let mut mutable = Addr::to_string()` and operate on that `String` instance.
+ */
+export type Addr = string
+/**
+ * Duration is a delta of time. You can add it to a BlockInfo or Expiration to move that further in the future. Note that an height-based Duration and a time-based Expiration cannot be combined
+ */
+export type Duration = ({
+height: number
+} | {
+time: number
 })
 
 /**

types/contracts/stake-cw20-gov/query_msg.d.ts

@@ -21,7 +21,7 @@ height?: (number | null)
 [k: string]: unknown
 }
 } | {
-unstaking_duration: {
+get_config: {
 [k: string]: unknown
 }
 } | {