Governance: Rename tokens_to_create to weight_to_create (#2839)

* chore: assert options length when serialising ProposalV1

* chore: rename tokens_to_create to weight_to_create

* fix: use saturating_sub for voting_proposal_count

* chore: update voting_proposal_count comments

* Revert "chore: update voting_proposal_count comments"

This reverts commit 3e2eb9d.

* Revert "fix: use saturating_sub for voting_proposal_count"

This reverts commit 5d35704.

Author: SebastianBor

governance/chat/program/tests/program_test/mod.rs

@@ -179,8 +179,8 @@ impl GovernanceChatProgramTest {
         let governed_account_address = Pubkey::new_unique();
 
         let governance_config = GovernanceConfig {
-            min_community_tokens_to_create_proposal: 5,
-            min_council_tokens_to_create_proposal: 2,
+            min_community_weight_to_create_proposal: 5,
+            min_council_weight_to_create_proposal: 2,
             min_transaction_hold_up_time: 10,
             max_voting_time: 10,
             vote_threshold_percentage: VoteThresholdPercentage::YesVote(60),

governance/program/src/instruction.rs

@@ -485,7 +485,7 @@ pub fn create_realm(
     max_community_voter_weight_addin: Option<Pubkey>,
     // Args
     name: String,
-    min_community_tokens_to_create_governance: u64,
+    min_community_weight_to_create_governance: u64,
     community_mint_max_vote_weight_source: MintMaxVoteWeightSource,
 ) -> Instruction {
     let realm_address = get_realm_address(program_id, &name);
@@ -544,7 +544,7 @@ pub fn create_realm(
     let instruction = GovernanceInstruction::CreateRealm {
         config_args: RealmConfigArgs {
             use_council_mint,
-            min_community_tokens_to_create_governance,
+            min_community_weight_to_create_governance,
             community_mint_max_vote_weight_source,
             use_community_voter_weight_addin,
             use_max_community_voter_weight_addin,
@@ -1350,7 +1350,7 @@ pub fn set_realm_config(
     community_voter_weight_addin: Option<Pubkey>,
     max_community_voter_weight_addin: Option<Pubkey>,
     // Args
-    min_community_tokens_to_create_governance: u64,
+    min_community_weight_to_create_governance: u64,
     community_mint_max_vote_weight_source: MintMaxVoteWeightSource,
 ) -> Instruction {
     let mut accounts = vec![
@@ -1405,7 +1405,7 @@ pub fn set_realm_config(
     let instruction = GovernanceInstruction::SetRealmConfig {
         config_args: RealmConfigArgs {
             use_council_mint,
-            min_community_tokens_to_create_governance,
+            min_community_weight_to_create_governance,
             community_mint_max_vote_weight_source,
             use_community_voter_weight_addin,
             use_max_community_voter_weight_addin,

governance/program/src/processor/process_create_realm.rs

@@ -137,8 +137,8 @@ pub fn process_create_realm(
             reserved: [0; 6],
             community_mint_max_vote_weight_source: config_args
                 .community_mint_max_vote_weight_source,
-            min_community_tokens_to_create_governance: config_args
-                .min_community_tokens_to_create_governance,
+            min_community_weight_to_create_governance: config_args
+                .min_community_weight_to_create_governance,
             use_community_voter_weight_addin: config_args.use_community_voter_weight_addin,
             use_max_community_voter_weight_addin: config_args.use_max_community_voter_weight_addin,
         },

governance/program/src/processor/process_set_realm_config.rs

@@ -148,8 +148,8 @@ pub fn process_set_realm_config(
     realm_data.config.community_mint_max_vote_weight_source =
         realm_config_args.community_mint_max_vote_weight_source;
 
-    realm_data.config.min_community_tokens_to_create_governance =
-        realm_config_args.min_community_tokens_to_create_governance;
+    realm_data.config.min_community_weight_to_create_governance =
+        realm_config_args.min_community_weight_to_create_governance;
 
     realm_data.config.use_community_voter_weight_addin =
         realm_config_args.use_community_voter_weight_addin;

governance/program/src/state/governance.rs

@@ -25,8 +25,8 @@ pub struct GovernanceConfig {
     /// Note: In the current version only YesVote threshold is supported
     pub vote_threshold_percentage: VoteThresholdPercentage,
 
-    /// Minimum number of community tokens a governance token owner must possess to be able to create a proposal
-    pub min_community_tokens_to_create_proposal: u64,
+    /// Minimum community weight a governance token owner must possess to be able to create a proposal
+    pub min_community_weight_to_create_proposal: u64,
 
     /// Minimum waiting time in seconds for a transaction to be executed after proposal is voted on
     pub min_transaction_hold_up_time: u32,
@@ -42,8 +42,8 @@ pub struct GovernanceConfig {
     /// Note: This field is not implemented in the current version
     pub proposal_cool_off_time: u32,
 
-    /// Minimum number of council tokens a governance token owner must possess to be able to create a proposal
-    pub min_council_tokens_to_create_proposal: u64,
+    /// Minimum council weight a governance token owner must possess to be able to create a proposal
+    pub min_council_weight_to_create_proposal: u64,
 }
 
 /// Governance Account

governance/program/src/state/legacy.rs

@@ -22,7 +22,7 @@ pub struct RealmConfigArgsV1 {
     pub use_council_mint: bool,
 
     /// Min number of community tokens required to create a governance
-    pub min_community_tokens_to_create_governance: u64,
+    pub min_community_weight_to_create_governance: u64,
 
     /// The source used for community mint max vote weight source
     pub community_mint_max_vote_weight_source: MintMaxVoteWeightSource,
@@ -57,7 +57,7 @@ pub struct RealmConfigV1 {
     pub reserved: [u8; 8],
 
     /// Min number of community tokens required to create a governance
-    pub min_community_tokens_to_create_governance: u64,
+    pub min_community_weight_to_create_governance: u64,
 
     /// The source used for community mint max vote weight source
     pub community_mint_max_vote_weight_source: MintMaxVoteWeightSource,

governance/program/src/state/proposal.rs

@@ -773,6 +773,10 @@ impl ProposalV2 {
                 panic!("ProposalV1 doesn't support max voting time")
             }
 
+            if self.options.len() != 1 {
+                panic!("ProposalV1 doesn't multiple options")
+            }
+
             let proposal_data_v1 = ProposalV1 {
                 account_type: self.account_type,
                 governance: self.governance,
@@ -1099,16 +1103,16 @@ mod test {
 
                 community_mint_max_vote_weight_source:
                     MintMaxVoteWeightSource::FULL_SUPPLY_FRACTION,
-                min_community_tokens_to_create_governance: 10,
+                min_community_weight_to_create_governance: 10,
             },
             voting_proposal_count: 0,
         }
     }
 
     fn create_test_governance_config() -> GovernanceConfig {
         GovernanceConfig {
-            min_community_tokens_to_create_proposal: 5,
-            min_council_tokens_to_create_proposal: 1,
+            min_community_weight_to_create_proposal: 5,
+            min_council_weight_to_create_proposal: 1,
             min_transaction_hold_up_time: 10,
             max_voting_time: 5,
             vote_threshold_percentage: VoteThresholdPercentage::YesVote(60),

governance/program/src/state/realm.rs

@@ -30,7 +30,7 @@ pub struct RealmConfigArgs {
     pub use_council_mint: bool,
 
     /// Min number of community tokens required to create a governance
-    pub min_community_tokens_to_create_governance: u64,
+    pub min_community_weight_to_create_governance: u64,
 
     /// The source used for community mint max vote weight source
     pub community_mint_max_vote_weight_source: MintMaxVoteWeightSource,
@@ -52,7 +52,7 @@ pub enum SetRealmAuthorityAction {
     SetUnchecked,
 
     /// Sets realm authority and checks the new new authority is one of the realm's governances
-    // Note: This is not a security feature because governance creation is only gated with min_community_tokens_to_create_governance
+    // Note: This is not a security feature because governance creation is only gated with min_community_weight_to_create_governance
     //       The check is done to prevent scenarios where the authority could be accidentally set to a wrong or none existing account
     SetChecked,
 
@@ -73,8 +73,8 @@ pub struct RealmConfig {
     /// Reserved space for future versions
     pub reserved: [u8; 6],
 
-    /// Min number of community tokens required to create a governance
-    pub min_community_tokens_to_create_governance: u64,
+    /// Min number of voter's community weight required to create a governance
+    pub min_community_weight_to_create_governance: u64,
 
     /// The source used for community mint max vote weight source
     pub community_mint_max_vote_weight_source: MintMaxVoteWeightSource,
@@ -342,7 +342,7 @@ mod test {
                 use_max_community_voter_weight_addin: false,
                 reserved: [0; 6],
                 community_mint_max_vote_weight_source: MintMaxVoteWeightSource::Absolute(100),
-                min_community_tokens_to_create_governance: 10,
+                min_community_weight_to_create_governance: 10,
             },
 
             voting_proposal_count: 0,
@@ -363,7 +363,7 @@ mod test {
                 council_mint: Some(Pubkey::new_unique()),
                 reserved: [0; 8],
                 community_mint_max_vote_weight_source: MintMaxVoteWeightSource::Absolute(100),
-                min_community_tokens_to_create_governance: 10,
+                min_community_weight_to_create_governance: 10,
             },
             reserved: [0; 8],
             authority: Some(Pubkey::new_unique()),
@@ -380,8 +380,8 @@ mod test {
         assert!(!realm_v2.config.use_community_voter_weight_addin);
         assert_eq!(realm_v2.account_type, GovernanceAccountType::Realm);
         assert_eq!(
-            realm_v2.config.min_community_tokens_to_create_governance,
-            realm_v1.config.min_community_tokens_to_create_governance,
+            realm_v2.config.min_community_weight_to_create_governance,
+            realm_v1.config.min_community_weight_to_create_governance,
         );
     }
 
@@ -392,7 +392,7 @@ mod test {
             name: "test-realm".to_string(),
             config_args: RealmConfigArgs {
                 use_council_mint: true,
-                min_community_tokens_to_create_governance: 100,
+                min_community_weight_to_create_governance: 100,
                 community_mint_max_vote_weight_source:
                     MintMaxVoteWeightSource::FULL_SUPPLY_FRACTION,
                 use_community_voter_weight_addin: false,

governance/program/src/state/token_owner_record.rs

@@ -110,9 +110,9 @@ impl TokenOwnerRecord {
     ) -> Result<(), ProgramError> {
         let min_weight_to_create_proposal =
             if self.governing_token_mint == realm_data.community_mint {
-                config.min_community_tokens_to_create_proposal
+                config.min_community_weight_to_create_proposal
             } else if Some(self.governing_token_mint) == realm_data.config.council_mint {
-                config.min_council_tokens_to_create_proposal
+                config.min_council_weight_to_create_proposal
             } else {
                 return Err(GovernanceError::InvalidGoverningTokenMint.into());
             };
@@ -138,7 +138,7 @@ impl TokenOwnerRecord {
     ) -> Result<(), ProgramError> {
         let min_weight_to_create_governance =
             if self.governing_token_mint == realm_data.community_mint {
-                realm_data.config.min_community_tokens_to_create_governance
+                realm_data.config.min_community_weight_to_create_governance
             } else if Some(self.governing_token_mint) == realm_data.config.council_mint {
                 // For council tokens it's enough to be in possession of any number of tokens
                 1

governance/program/tests/process_create_realm.rs

@@ -36,7 +36,7 @@ async fn test_create_realm_with_non_default_config() {
     let realm_config_args = RealmConfigArgs {
         use_council_mint: false,
         community_mint_max_vote_weight_source: MintMaxVoteWeightSource::SupplyFraction(1),
-        min_community_tokens_to_create_governance: 10,
+        min_community_weight_to_create_governance: 10,
         use_community_voter_weight_addin: false,
         use_max_community_voter_weight_addin: false,
     };