Governance: Active proposal count (#131)

* feat: Add active_proposal_count to Governance

* feat: Reallocate GovernanceV1 to GovernanceV2

* chore: test_create_proposal_and_migrate_v1_governance_to_v2

* chore: Cleanup code

* chore: Update comments

* chore: Use assert_is_valid_realm instead of deserializing the account

* chore: Update comments

* chore: Update comments

* chore: Check for empty account first

* chore: Update comments

* fix: Assert new account size is greater than the existing one

Author: SebastianBor

governance/program/src/instruction.rs

@@ -166,7 +166,7 @@ pub enum GovernanceInstruction {
     ///
     ///   0. `[]` Realm account the created Proposal belongs to
     ///   1. `[writable]` Proposal account. PDA seeds ['governance',governance, governing_token_mint, proposal_seed]
-    ///   2. `[]` Governance account
+    ///   2. `[writable]` Governance account
     ///   3. `[writable]` TokenOwnerRecord account of the Proposal owner
     ///   4. `[]` Governing Token Mint the Proposal is created for
     ///   5. `[signer]` Governance Authority (Token Owner or Governance Delegate)
@@ -270,7 +270,7 @@ pub enum GovernanceInstruction {
     /// Cancels Proposal by changing its state to Canceled
     ///
     ///   0. `[]` Realm account
-    ///   1. `[]` Governance account
+    ///   1. `[writable]` Governance account
     ///   2. `[writable]` Proposal account
     ///   3. `[writable]`  TokenOwnerRecord account of the  Proposal owner
     ///   4. `[signer]` Governance Authority (Token Owner or Governance Delegate)
@@ -296,7 +296,7 @@ pub enum GovernanceInstruction {
     ///  If you tip the consensus then the transactions can begin to be run after their hold up time
     ///
     ///   0. `[]` Realm account
-    ///   1. `[]` Governance account
+    ///   1. `[writable]` Governance account
     ///   2. `[writable]` Proposal account
     ///   3. `[writable]` TokenOwnerRecord of the Proposal owner
     ///   4. `[writable]` TokenOwnerRecord of the voter. PDA seeds: ['governance',realm, vote_governing_token_mint, governing_token_owner]
@@ -321,7 +321,7 @@ pub enum GovernanceInstruction {
     /// Finalizes vote in case the Vote was not automatically tipped within max_voting_time period
     ///
     ///   0. `[]` Realm account    
-    ///   1. `[]` Governance account
+    ///   1. `[writable]` Governance account
     ///   2. `[writable]` Proposal account
     ///   3. `[writable]` TokenOwnerRecord of the Proposal owner        
     ///   4. `[]` Governing Token Mint
@@ -909,7 +909,7 @@ pub fn create_proposal(
     let mut accounts = vec![
         AccountMeta::new_readonly(*realm, false),
         AccountMeta::new(proposal_address, false),
-        AccountMeta::new_readonly(*governance, false),
+        AccountMeta::new(*governance, false),
         AccountMeta::new(*proposal_owner_record, false),
         AccountMeta::new_readonly(*governing_token_mint, false),
         AccountMeta::new_readonly(*governance_authority, true),
@@ -1056,7 +1056,7 @@ pub fn cast_vote(
 
     let mut accounts = vec![
         AccountMeta::new_readonly(*realm, false),
-        AccountMeta::new_readonly(*governance, false),
+        AccountMeta::new(*governance, false),
         AccountMeta::new(*proposal, false),
         AccountMeta::new(*proposal_owner_record, false),
         AccountMeta::new(*voter_token_owner_record, false),
@@ -1097,7 +1097,7 @@ pub fn finalize_vote(
 ) -> Instruction {
     let mut accounts = vec![
         AccountMeta::new_readonly(*realm, false),
-        AccountMeta::new_readonly(*governance, false),
+        AccountMeta::new(*governance, false),
         AccountMeta::new(*proposal, false),
         AccountMeta::new(*proposal_owner_record, false),
         AccountMeta::new_readonly(*governing_token_mint, false),
@@ -1170,7 +1170,7 @@ pub fn cancel_proposal(
 ) -> Instruction {
     let accounts = vec![
         AccountMeta::new_readonly(*realm, false),
-        AccountMeta::new_readonly(*governance, false),
+        AccountMeta::new(*governance, false),
         AccountMeta::new(*proposal, false),
         AccountMeta::new(*proposal_owner_record, false),
         AccountMeta::new_readonly(*governance_authority, true),

governance/program/src/processor/process_cancel_proposal.rs

@@ -10,7 +10,7 @@ use solana_program::{
 
 use crate::state::{
     enums::ProposalState, governance::get_governance_data_for_realm,
-    proposal::get_proposal_data_for_governance, realm::get_realm_data,
+    proposal::get_proposal_data_for_governance, realm::assert_is_valid_realm,
     token_owner_record::get_token_owner_record_data_for_proposal_owner,
 };
 
@@ -26,11 +26,9 @@ pub fn process_cancel_proposal(program_id: &Pubkey, accounts: &[AccountInfo]) ->
 
     let clock = Clock::get()?;
 
-    // Realm is deserialized to validate the account
-    // Note: It'll be used in the future versions to track active proposals
-    let _realm_data = get_realm_data(program_id, realm_info)?;
+    assert_is_valid_realm(program_id, realm_info)?;
 
-    let governance_data =
+    let mut governance_data =
         get_governance_data_for_realm(program_id, governance_info, realm_info.key)?;
 
     let mut proposal_data =
@@ -54,5 +52,9 @@ pub fn process_cancel_proposal(program_id: &Pubkey, accounts: &[AccountInfo]) ->
 
     proposal_data.serialize(&mut *proposal_info.data.borrow_mut())?;
 
+    // Update  Governance active_proposal_count
+    governance_data.active_proposal_count = governance_data.active_proposal_count.saturating_sub(1);
+    governance_data.serialize(&mut *governance_info.data.borrow_mut())?;
+
     Ok(())
 }

governance/program/src/processor/process_cast_vote.rs

@@ -63,7 +63,7 @@ pub fn process_cast_vote(
         vote_governing_token_mint_info.key,
     )?;
 
-    let governance_data =
+    let mut governance_data =
         get_governance_data_for_realm(program_id, governance_info, realm_info.key)?;
 
     let vote_kind = get_vote_kind(&vote);
@@ -181,6 +181,11 @@ pub fn process_cast_vote(
             proposal_owner_record_data
                 .serialize(&mut *proposal_owner_record_info.data.borrow_mut())?;
         };
+
+        // If the proposal is tipped decrease Governance active_proposal_count
+        governance_data.active_proposal_count =
+            governance_data.active_proposal_count.saturating_sub(1);
+        governance_data.serialize(&mut *governance_info.data.borrow_mut())?;
     }
 
     let governing_token_owner = voter_token_owner_record_data.governing_token_owner;

governance/program/src/processor/process_create_governance.rs

@@ -1,12 +1,15 @@
 //! Program state processor
 
-use crate::state::{
-    enums::GovernanceAccountType,
-    governance::{
-        assert_valid_create_governance_args, get_governance_address_seeds, GovernanceConfig,
-        GovernanceV2,
+use crate::{
+    state::{
+        enums::GovernanceAccountType,
+        governance::{
+            assert_valid_create_governance_args, get_governance_address_seeds, GovernanceConfig,
+            GovernanceV2,
+        },
+        realm::get_realm_data,
     },
-    realm::get_realm_data,
+    tools::structs::Reserved120,
 };
 use solana_program::{
     account_info::{next_account_info, AccountInfo},
@@ -57,7 +60,8 @@ pub fn process_create_governance(
         governed_account: *governed_account_info.key,
         config,
         reserved1: 0,
-        reserved_v2: [0; 128],
+        reserved_v2: Reserved120::default(),
+        active_proposal_count: 0,
     };
 
     create_and_serialize_account_signed::<GovernanceV2>(

governance/program/src/processor/process_create_mint_governance.rs

@@ -9,8 +9,9 @@ use crate::{
         },
         realm::get_realm_data,
     },
-    tools::spl_token::{
-        assert_spl_token_mint_authority_is_signer, set_spl_token_account_authority,
+    tools::{
+        spl_token::{assert_spl_token_mint_authority_is_signer, set_spl_token_account_authority},
+        structs::Reserved120,
     },
 };
 use solana_program::{
@@ -69,7 +70,8 @@ pub fn process_create_mint_governance(
         governed_account: *governed_mint_info.key,
         config,
         reserved1: 0,
-        reserved_v2: [0; 128],
+        reserved_v2: Reserved120::default(),
+        active_proposal_count: 0,
     };
 
     create_and_serialize_account_signed::<GovernanceV2>(

governance/program/src/processor/process_create_program_governance.rs

@@ -10,8 +10,11 @@ use crate::{
         },
         realm::get_realm_data,
     },
-    tools::bpf_loader_upgradeable::{
-        assert_program_upgrade_authority_is_signer, set_program_upgrade_authority,
+    tools::{
+        bpf_loader_upgradeable::{
+            assert_program_upgrade_authority_is_signer, set_program_upgrade_authority,
+        },
+        structs::Reserved120,
     },
 };
 use solana_program::{
@@ -69,7 +72,8 @@ pub fn process_create_program_governance(
         governed_account: *governed_program_info.key,
         config,
         reserved1: 0,
-        reserved_v2: [0; 128],
+        reserved_v2: Reserved120::default(),
+        active_proposal_count: 0,
     };
 
     create_and_serialize_account_signed::<GovernanceV2>(

governance/program/src/processor/process_create_proposal.rs

@@ -65,7 +65,7 @@ pub fn process_create_proposal(
         governing_token_mint_info.key,
     )?;
 
-    let governance_data =
+    let mut governance_data =
         get_governance_data_for_realm(program_id, governance_info, realm_info.key)?;
 
     governance_data.assert_governing_token_mint_can_vote(
@@ -178,5 +178,13 @@ pub fn process_create_proposal(
         &rent,
     )?;
 
+    governance_data.active_proposal_count = governance_data
+        .active_proposal_count
+        .checked_add(1)
+        .unwrap();
+
+    // Serialize the governance account update to GovernanceV2 if needed
+    governance_data.serialize_as_governance_v2(governance_info, payer_info, system_info, &rent)?;
+
     Ok(())
 }

governance/program/src/processor/process_create_realm.rs

@@ -19,10 +19,9 @@ use crate::{
         },
         realm_config::{
             get_realm_config_address_seeds, resolve_governing_token_config, RealmConfigAccount,
-            Reserved110,
         },
     },
-    tools::spl_token::create_spl_token_account_signed,
+    tools::{spl_token::create_spl_token_account_signed, structs::Reserved110},
 };
 
 /// Processes CreateRealm instruction

governance/program/src/processor/process_create_token_governance.rs

@@ -9,7 +9,10 @@ use crate::{
         },
         realm::get_realm_data,
     },
-    tools::spl_token::{assert_spl_token_owner_is_signer, set_spl_token_account_authority},
+    tools::{
+        spl_token::{assert_spl_token_owner_is_signer, set_spl_token_account_authority},
+        structs::Reserved120,
+    },
 };
 use solana_program::{
     account_info::{next_account_info, AccountInfo},
@@ -67,7 +70,8 @@ pub fn process_create_token_governance(
         governed_account: *governed_token_info.key,
         config,
         reserved1: 0,
-        reserved_v2: [0; 128],
+        reserved_v2: Reserved120::default(),
+        active_proposal_count: 0,
     };
 
     create_and_serialize_account_signed::<GovernanceV2>(

governance/program/src/processor/process_finalize_vote.rs

@@ -33,7 +33,7 @@ pub fn process_finalize_vote(program_id: &Pubkey, accounts: &[AccountInfo]) -> P
         realm_info,
         governing_token_mint_info.key,
     )?;
-    let governance_data =
+    let mut governance_data =
         get_governance_data_for_realm(program_id, governance_info, realm_info.key)?;
 
     let mut proposal_data = get_proposal_data_for_governance_and_governing_mint(
@@ -80,5 +80,9 @@ pub fn process_finalize_vote(program_id: &Pubkey, accounts: &[AccountInfo]) -> P
 
     proposal_data.serialize(&mut *proposal_info.data.borrow_mut())?;
 
+    // Update  Governance active_proposal_count
+    governance_data.active_proposal_count = governance_data.active_proposal_count.saturating_sub(1);
+    governance_data.serialize(&mut *governance_info.data.borrow_mut())?;
+
     Ok(())
 }