Governance: Remove TokenOwnerRecord total_votes_count (#130)

* feat: Extend unrelinquished_votes_count to u64

* chore: Update comments and names

* chore: Update asserts

* chore: Update comments

* chore: Use u32:MAX to trim unrelinquished_votes_count

* chore: Make Clippy happy

* chore: Update versioning cleanup comments

Author: SebastianBor

governance/program/src/processor/process_cast_vote.rs

@@ -100,11 +100,6 @@ pub fn process_cast_vote(
         .checked_add(1)
         .unwrap();
 
-    voter_token_owner_record_data.total_votes_count = voter_token_owner_record_data
-        .total_votes_count
-        .checked_add(1)
-        .unwrap();
-
     let realm_config_info = next_account_info(account_info_iter)?; // 9
     let realm_config_data =
         get_realm_config_data_for_realm(program_id, realm_config_info, realm_info.key)?;

governance/program/src/processor/process_create_token_owner_record.rs

@@ -14,7 +14,9 @@ use crate::{
     state::{
         enums::GovernanceAccountType,
         realm::get_realm_data,
-        token_owner_record::{get_token_owner_record_address_seeds, TokenOwnerRecordV2},
+        token_owner_record::{
+            get_token_owner_record_address_seeds, TokenOwnerRecordV2, TOKEN_OWNER_RECORD_VERSION,
+        },
     },
 };
 
@@ -48,9 +50,9 @@ pub fn process_create_token_owner_record(
         governing_token_mint: *governing_token_mint_info.key,
         governance_delegate: None,
         unrelinquished_votes_count: 0,
-        total_votes_count: 0,
         outstanding_proposal_count: 0,
-        reserved: [0; 7],
+        version: TOKEN_OWNER_RECORD_VERSION,
+        reserved: [0; 6],
         reserved_v2: [0; 128],
     };
 

governance/program/src/processor/process_deposit_governing_tokens.rs

@@ -17,7 +17,7 @@ use crate::{
         realm_config::get_realm_config_data_for_realm,
         token_owner_record::{
             get_token_owner_record_address_seeds, get_token_owner_record_data_for_seeds,
-            TokenOwnerRecordV2,
+            TokenOwnerRecordV2, TOKEN_OWNER_RECORD_VERSION,
         },
     },
     tools::spl_token::{
@@ -104,9 +104,9 @@ pub fn process_deposit_governing_tokens(
             governing_token_mint,
             governance_delegate: None,
             unrelinquished_votes_count: 0,
-            total_votes_count: 0,
             outstanding_proposal_count: 0,
-            reserved: [0; 7],
+            version: TOKEN_OWNER_RECORD_VERSION,
+            reserved: [0; 6],
             reserved_v2: [0; 128],
         };
 

governance/program/src/processor/process_relinquish_vote.rs

@@ -110,11 +110,6 @@ pub fn process_relinquish_vote(program_id: &Pubkey, accounts: &[AccountInfo]) ->
         proposal_data.serialize(&mut *proposal_info.data.borrow_mut())?;
 
         dispose_account(vote_record_info, beneficiary_info)?;
-
-        token_owner_record_data.total_votes_count = token_owner_record_data
-            .total_votes_count
-            .checked_sub(1)
-            .unwrap();
     } else {
         // After Proposal voting time ends and it's not tipped then it enters implicit (time based) Finalizing state
         // and releasing tokens in this state should be disallowed

governance/program/src/processor/process_set_realm_config.rs

@@ -95,7 +95,7 @@ pub fn process_set_realm_config(
 
     // Update or create RealmConfigAccount
     if realm_config_info.data_is_empty() {
-        // For older Realms (pre v3) RealmConfigAccount might not exist yet and we have to create it
+        // For older Realm accounts (pre program V3) RealmConfigAccount might not exist yet and we have to create it
 
         // We need the payer to pay for the new account if it's created
         let payer_info = next_account_info(account_info_iter)?; // 10

governance/program/src/state/governance.rs

@@ -294,7 +294,7 @@ pub fn get_governance_data(
     // Note: assert_is_valid_governance_config() prevents setting council_vote_threshold to VoteThreshold::YesVotePercentage(0)
     // which gives as guarantee that it is a legacy account layout set with proposal_cool_off_time = 0
     //
-    // Note: All the settings below are one time config migration from V1 & V2 account data to V3
+    // Note: All the settings below are one time config migration from program V1 & V2 account data to V3
     if governance_data.config.council_vote_threshold == VoteThreshold::YesVotePercentage(0) {
         // Set council_vote_threshold to community_vote_threshold which was used for both council and community thresholds before
         governance_data.config.council_vote_threshold =
@@ -652,7 +652,7 @@ mod test {
     }
 
     #[test]
-    fn test_migrate_governance_config_from_legacy_data_to_v3() {
+    fn test_migrate_governance_config_from_legacy_data_to_program_v3() {
         // Arrange
         let mut governance_legacy_data = create_test_governance();
 
@@ -689,32 +689,32 @@ mod test {
             Epoch::default(),
         );
         // Act
-        let governance_v3 = get_governance_data(&program_id, &legacy_account_info).unwrap();
+        let governance_program_v3 = get_governance_data(&program_id, &legacy_account_info).unwrap();
 
         // Assert
         assert_eq!(
-            governance_v3.config.council_vote_threshold,
+            governance_program_v3.config.council_vote_threshold,
             VoteThreshold::YesVotePercentage(60)
         );
 
         assert_eq!(
-            governance_v3.config.council_veto_vote_threshold,
+            governance_program_v3.config.council_veto_vote_threshold,
             VoteThreshold::YesVotePercentage(60)
         );
 
         assert_eq!(
-            governance_v3.config.community_veto_vote_threshold,
+            governance_program_v3.config.community_veto_vote_threshold,
             VoteThreshold::Disabled
         );
 
         assert_eq!(
-            governance_v3.config.council_vote_tipping,
+            governance_program_v3.config.council_vote_tipping,
             VoteTipping::Strict
         );
 
-        assert_eq!(governance_v3.config.voting_cool_off_time, 0);
+        assert_eq!(governance_program_v3.config.voting_cool_off_time, 0);
 
-        assert_eq!(governance_v3.config.reserved, 0);
+        assert_eq!(governance_program_v3.config.reserved, 0);
     }
 
     #[test]

governance/program/src/state/legacy.rs

@@ -74,20 +74,19 @@ pub struct TokenOwnerRecordV1 {
 
     /// The number of votes cast by TokenOwner but not relinquished yet
     /// Every time a vote is cast this number is increased and it's always decreased when relinquishing a vote regardless of the vote state
-    pub unrelinquished_votes_count: u32,
-
-    /// The total number of votes cast by the TokenOwner
-    /// If TokenOwner withdraws vote while voting is still in progress total_votes_count is decreased  and the vote doesn't count towards the total
-    pub total_votes_count: u32,
+    pub unrelinquished_votes_count: u64,
 
     /// The number of outstanding proposals the TokenOwner currently owns
     /// The count is increased when TokenOwner creates a proposal
     /// and decreased  once it's either voted on (Succeeded or Defeated) or Cancelled
-    /// By default it's restricted to 1 outstanding Proposal per token owner
+    /// By default it's restricted to 10 outstanding Proposal per token owner
     pub outstanding_proposal_count: u8,
 
+    /// Version introduced in program V3
+    pub version: u8,
+
     /// Reserved space for future versions
-    pub reserved: [u8; 7],
+    pub reserved: [u8; 6],
 
     /// A single account that is allowed to operate governance with the deposited governing tokens
     /// It can be delegated to by the governing_token_owner or current governance_delegate

governance/program/src/state/realm.rs

@@ -137,7 +137,7 @@ pub struct RealmV2 {
     /// Reserved space for future versions
     pub reserved: [u8; 6],
 
-    /// Legacy field not used since V3 any longer
+    /// Legacy field not used since program V3 any longer
     /// Note: If the field is going to be reused in future version it must be taken under consideration
     /// that for some Realms it might be already set to none zero because it was used as voting_proposal_count before
     pub legacy1: u16,