Governance: Implement Absolute max voter weight source (#3627)

* feat: Implement Absolute max voter weight source

* chore: Rename max_vote_weight to max_voter_weight

* chore: update comments

* chore: test_try_tip_vote_with_reduced_absolute_mint_max_vote_weight_and_vote_overflow

Co-authored-by: Jon Cinque <[email protected]>

Author: SebastianBor

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

@@ -10,7 +10,7 @@ use spl_governance::{
         deposit_governing_tokens,
     },
     state::{
-        enums::{MintMaxVoteWeightSource, VoteThreshold},
+        enums::{MintMaxVoterWeightSource, VoteThreshold},
         governance::{get_governance_address, GovernanceConfig},
         proposal::{get_proposal_address, VoteType},
         realm::{get_realm_address, GoverningTokenConfigAccountArgs},
@@ -125,7 +125,7 @@ impl GovernanceChatProgramTest {
             None,
             name.clone(),
             1,
-            MintMaxVoteWeightSource::FULL_SUPPLY_FRACTION,
+            MintMaxVoterWeightSource::FULL_SUPPLY_FRACTION,
         );
 
         self.bench

governance/program/src/error.rs

@@ -291,13 +291,13 @@ pub enum GovernanceError {
     #[error("Realm council mint change is not supported")]
     RealmCouncilMintChangeIsNotSupported,
 
-    /// Not supported mint max vote weight sourcef
-    #[error("Not supported mint max vote weight source")]
-    MintMaxVoteWeightSourceNotSupported,
+    /// Invalid max voter weight absolute value
+    #[error("Invalid max voter weight absolute value")]
+    InvalidMaxVoterWeightAbsoluteValue,
 
-    /// Invalid max vote weight supply fraction
-    #[error("Invalid max vote weight supply fraction")]
-    InvalidMaxVoteWeightSupplyFraction,
+    /// Invalid max voter weight supply fraction
+    #[error("Invalid max voter weight supply fraction")]
+    InvalidMaxVoterWeightSupplyFraction,
 
     /// Owner doesn't have enough governing tokens to create Governance
     #[error("Owner doesn't have enough governing tokens to create Governance")]

governance/program/src/instruction.rs

@@ -2,7 +2,7 @@
 
 use crate::{
     state::{
-        enums::MintMaxVoteWeightSource,
+        enums::MintMaxVoterWeightSource,
         governance::{
             get_governance_address, get_mint_governance_address, get_program_governance_address,
             get_token_governance_address, GovernanceConfig,
@@ -522,7 +522,7 @@ pub fn create_realm(
     // Args
     name: String,
     min_community_weight_to_create_governance: u64,
-    community_mint_max_vote_weight_source: MintMaxVoteWeightSource,
+    community_mint_max_voter_weight_source: MintMaxVoterWeightSource,
 ) -> Instruction {
     let realm_address = get_realm_address(program_id, &name);
     let community_token_holding_address =
@@ -563,7 +563,7 @@ pub fn create_realm(
         config_args: RealmConfigArgs {
             use_council_mint,
             min_community_weight_to_create_governance,
-            community_mint_max_vote_weight_source,
+            community_mint_max_voter_weight_source,
             community_token_config_args,
             council_token_config_args,
         },
@@ -1379,7 +1379,7 @@ pub fn set_realm_config(
     council_token_config_args: Option<GoverningTokenConfigAccountArgs>,
     // Args
     min_community_weight_to_create_governance: u64,
-    community_mint_max_vote_weight_source: MintMaxVoteWeightSource,
+    community_mint_max_voter_weight_source: MintMaxVoterWeightSource,
 ) -> Instruction {
     let mut accounts = vec![
         AccountMeta::new(*realm, false),
@@ -1416,7 +1416,7 @@ pub fn set_realm_config(
         config_args: RealmConfigArgs {
             use_council_mint,
             min_community_weight_to_create_governance,
-            community_mint_max_vote_weight_source,
+            community_mint_max_voter_weight_source,
             community_token_config_args,
             council_token_config_args,
         },

governance/program/src/processor/process_create_realm.rs

@@ -132,8 +132,8 @@ pub fn process_create_realm(
         config: RealmConfig {
             council_mint: council_token_mint_address,
             reserved: [0; 6],
-            community_mint_max_vote_weight_source: realm_config_args
-                .community_mint_max_vote_weight_source,
+            community_mint_max_voter_weight_source: realm_config_args
+                .community_mint_max_voter_weight_source,
             min_community_weight_to_create_governance: realm_config_args
                 .min_community_weight_to_create_governance,
             legacy1: 0,

governance/program/src/processor/process_set_realm_config.rs

@@ -121,8 +121,8 @@ pub fn process_set_realm_config(
     }
 
     // Update RealmConfig (Realm.config field)
-    realm_data.config.community_mint_max_vote_weight_source =
-        realm_config_args.community_mint_max_vote_weight_source;
+    realm_data.config.community_mint_max_voter_weight_source =
+        realm_config_args.community_mint_max_voter_weight_source;
 
     realm_data.config.min_community_weight_to_create_governance =
         realm_config_args.min_community_weight_to_create_governance;

governance/program/src/state/enums.rs

@@ -225,21 +225,20 @@ pub enum InstructionExecutionFlags {
 /// The source of max vote weight used for voting
 /// Values below 100% mint supply can be used when the governing token is fully minted but not distributed yet
 #[derive(Clone, Debug, PartialEq, Eq, BorshDeserialize, BorshSerialize, BorshSchema)]
-pub enum MintMaxVoteWeightSource {
+pub enum MintMaxVoterWeightSource {
     /// Fraction (10^10 precision) of the governing mint supply is used as max vote weight
     /// The default is 100% (10^10) to use all available mint supply for voting
     SupplyFraction(u64),
 
-    /// Absolute value, irrelevant of the actual mint supply, is used as max vote weight
-    /// Note: this option is not implemented in the current version
+    /// Absolute value, irrelevant of the actual mint supply, is used as max voter weight
     Absolute(u64),
 }
 
-impl MintMaxVoteWeightSource {
+impl MintMaxVoterWeightSource {
     /// Base for mint supply fraction calculation
     pub const SUPPLY_FRACTION_BASE: u64 = 10_000_000_000;
 
     /// 100% of mint supply
-    pub const FULL_SUPPLY_FRACTION: MintMaxVoteWeightSource =
-        MintMaxVoteWeightSource::SupplyFraction(MintMaxVoteWeightSource::SUPPLY_FRACTION_BASE);
+    pub const FULL_SUPPLY_FRACTION: MintMaxVoterWeightSource =
+        MintMaxVoterWeightSource::SupplyFraction(MintMaxVoterWeightSource::SUPPLY_FRACTION_BASE);
 }

governance/program/src/state/proposal.rs

@@ -24,7 +24,7 @@ use crate::{
     error::GovernanceError,
     state::{
         enums::{
-            GovernanceAccountType, InstructionExecutionFlags, MintMaxVoteWeightSource,
+            GovernanceAccountType, InstructionExecutionFlags, MintMaxVoterWeightSource,
             ProposalState, TransactionExecutionStatus, VoteThreshold, VoteTipping,
         },
         governance::GovernanceConfig,
@@ -432,26 +432,24 @@ impl ProposalV2 {
             return Ok(governing_token_mint_supply);
         }
 
-        match realm_data.config.community_mint_max_vote_weight_source {
-            MintMaxVoteWeightSource::SupplyFraction(fraction) => {
-                if fraction == MintMaxVoteWeightSource::SUPPLY_FRACTION_BASE {
+        let max_voter_weight = match realm_data.config.community_mint_max_voter_weight_source {
+            MintMaxVoterWeightSource::SupplyFraction(fraction) => {
+                if fraction == MintMaxVoterWeightSource::SUPPLY_FRACTION_BASE {
                     return Ok(governing_token_mint_supply);
                 }
 
-                let max_voter_weight = (governing_token_mint_supply as u128)
+                (governing_token_mint_supply as u128)
                     .checked_mul(fraction as u128)
                     .unwrap()
-                    .checked_div(MintMaxVoteWeightSource::SUPPLY_FRACTION_BASE as u128)
-                    .unwrap() as u64;
-
-                // When the fraction is used it's possible we can go over the calculated max_vote_weight
-                // and we have to adjust it in case more votes have been cast
-                Ok(self.coerce_max_voter_weight(max_voter_weight, vote_kind))
-            }
-            MintMaxVoteWeightSource::Absolute(_) => {
-                Err(GovernanceError::VoteWeightSourceNotSupported.into())
+                    .checked_div(MintMaxVoterWeightSource::SUPPLY_FRACTION_BASE as u128)
+                    .unwrap() as u64
             }
-        }
+            MintMaxVoterWeightSource::Absolute(value) => value,
+        };
+
+        // When the fraction or absolute value is used it's possible we can go over the calculated max_vote_weight
+        // and we have to adjust it in case more votes have been cast
+        Ok(self.coerce_max_voter_weight(max_voter_weight, vote_kind))
     }
 
     /// Adjusts max voter weight to ensure it's not lower than total cast votes
@@ -1057,7 +1055,7 @@ mod test {
     use solana_program::clock::Epoch;
 
     use crate::state::{
-        enums::{MintMaxVoteWeightSource, VoteThreshold},
+        enums::{MintMaxVoterWeightSource, VoteThreshold},
         legacy::ProposalV1,
         realm::RealmConfig,
         vote_record::VoteChoice,
@@ -1158,8 +1156,8 @@ mod test {
                 legacy1: 0,
                 legacy2: 0,
 
-                community_mint_max_vote_weight_source:
-                    MintMaxVoteWeightSource::FULL_SUPPLY_FRACTION,
+                community_mint_max_voter_weight_source:
+                    MintMaxVoterWeightSource::FULL_SUPPLY_FRACTION,
                 min_community_weight_to_create_governance: 10,
             },
             voting_proposal_count: 0,
@@ -1801,9 +1799,9 @@ mod test {
         let vote_tipping = VoteTipping::Strict;
 
         // reduce max vote weight to 100
-        realm.config.community_mint_max_vote_weight_source =
-            MintMaxVoteWeightSource::SupplyFraction(
-                MintMaxVoteWeightSource::SUPPLY_FRACTION_BASE / 2,
+        realm.config.community_mint_max_voter_weight_source =
+            MintMaxVoterWeightSource::SupplyFraction(
+                MintMaxVoterWeightSource::SUPPLY_FRACTION_BASE / 2,
             );
 
         let max_voter_weight = proposal
@@ -1834,6 +1832,57 @@ mod test {
         assert_eq!(proposal.max_vote_weight, Some(100));
     }
 
+    #[test]
+    fn test_try_tip_vote_with_reduced_absolute_community_mint_max_vote_weight() {
+        // Arrange
+        let mut proposal = create_test_proposal();
+
+        proposal.options[0].vote_weight = 60;
+        proposal.deny_vote_weight = Some(10);
+
+        proposal.state = ProposalState::Voting;
+
+        let current_timestamp = 15_i64;
+
+        let community_token_supply = 200;
+
+        let mut realm = create_test_realm();
+        let governing_token_mint = proposal.governing_token_mint;
+        let vote_kind = VoteKind::Electorate;
+        let vote_tipping = VoteTipping::Strict;
+
+        // set max vote weight to 100
+        realm.config.community_mint_max_voter_weight_source =
+            MintMaxVoterWeightSource::Absolute(community_token_supply / 2);
+
+        let max_voter_weight = proposal
+            .get_max_voter_weight_from_mint_supply(
+                &realm,
+                &governing_token_mint,
+                community_token_supply,
+                &vote_kind,
+            )
+            .unwrap();
+
+        let vote_threshold = &VoteThreshold::YesVotePercentage(60);
+        let vote_kind = VoteKind::Electorate;
+
+        // Act
+        proposal
+            .try_tip_vote(
+                max_voter_weight,
+                &vote_tipping,
+                current_timestamp,
+                vote_threshold,
+                &vote_kind,
+            )
+            .unwrap();
+
+        // Assert
+        assert_eq!(proposal.state, ProposalState::Succeeded);
+        assert_eq!(proposal.max_vote_weight, Some(100));
+    }
+
     #[test]
     fn test_try_tip_vote_with_reduced_community_mint_max_vote_weight_and_vote_overflow() {
         // Arrange
@@ -1854,9 +1903,9 @@ mod test {
         let vote_tipping = VoteTipping::Strict;
 
         // reduce max vote weight to 100
-        realm.config.community_mint_max_vote_weight_source =
-            MintMaxVoteWeightSource::SupplyFraction(
-                MintMaxVoteWeightSource::SUPPLY_FRACTION_BASE / 2,
+        realm.config.community_mint_max_voter_weight_source =
+            MintMaxVoterWeightSource::SupplyFraction(
+                MintMaxVoterWeightSource::SUPPLY_FRACTION_BASE / 2,
             );
 
         // vote above reduced supply
@@ -1890,6 +1939,60 @@ mod test {
         assert_eq!(proposal.max_vote_weight, Some(130));
     }
 
+    #[test]
+    fn test_try_tip_vote_with_reduced_absolute_mint_max_vote_weight_and_vote_overflow() {
+        // Arrange
+        let mut proposal = create_test_proposal();
+
+        // no vote weight
+        proposal.deny_vote_weight = Some(10);
+
+        proposal.state = ProposalState::Voting;
+
+        let current_timestamp = 15_i64;
+
+        let community_token_supply = 200;
+
+        let mut realm = create_test_realm();
+        let governing_token_mint = proposal.governing_token_mint;
+        let vote_kind = VoteKind::Electorate;
+        let vote_tipping = VoteTipping::Strict;
+
+        // reduce max vote weight to 100
+        realm.config.community_mint_max_voter_weight_source =
+            MintMaxVoterWeightSource::Absolute(community_token_supply / 2);
+
+        // vote above reduced supply
+        // Yes vote weight
+        proposal.options[0].vote_weight = 120;
+
+        let max_voter_weight = proposal
+            .get_max_voter_weight_from_mint_supply(
+                &realm,
+                &governing_token_mint,
+                community_token_supply,
+                &vote_kind,
+            )
+            .unwrap();
+
+        let vote_threshold = VoteThreshold::YesVotePercentage(60);
+
+        // Act
+        proposal
+            .try_tip_vote(
+                max_voter_weight,
+                &vote_tipping,
+                current_timestamp,
+                &vote_threshold,
+                &vote_kind,
+            )
+            .unwrap();
+
+        // Assert
+        assert_eq!(proposal.state, ProposalState::Succeeded);
+        assert_eq!(proposal.max_vote_weight, Some(130)); // Deny Vote 10 + Approve Vote 120
+    }
+
     #[test]
     fn test_try_tip_vote_for_council_vote_with_reduced_community_mint_max_vote_weight() {
         // Arrange
@@ -1909,9 +2012,9 @@ mod test {
         let vote_kind = VoteKind::Electorate;
         let vote_tipping = VoteTipping::Strict;
 
-        realm.config.community_mint_max_vote_weight_source =
-            MintMaxVoteWeightSource::SupplyFraction(
-                MintMaxVoteWeightSource::SUPPLY_FRACTION_BASE / 2,
+        realm.config.community_mint_max_voter_weight_source =
+            MintMaxVoterWeightSource::SupplyFraction(
+                MintMaxVoterWeightSource::SUPPLY_FRACTION_BASE / 2,
             );
         realm.config.council_mint = Some(proposal.governing_token_mint);
 
@@ -1961,9 +2064,9 @@ mod test {
         let vote_kind = VoteKind::Electorate;
 
         // reduce max vote weight to 100
-        realm.config.community_mint_max_vote_weight_source =
-            MintMaxVoteWeightSource::SupplyFraction(
-                MintMaxVoteWeightSource::SUPPLY_FRACTION_BASE / 2,
+        realm.config.community_mint_max_voter_weight_source =
+            MintMaxVoterWeightSource::SupplyFraction(
+                MintMaxVoterWeightSource::SUPPLY_FRACTION_BASE / 2,
             );
 
         let max_voter_weight = proposal
@@ -2012,9 +2115,9 @@ mod test {
         let vote_kind = VoteKind::Electorate;
 
         // reduce max vote weight to 100
-        realm.config.community_mint_max_vote_weight_source =
-            MintMaxVoteWeightSource::SupplyFraction(
-                MintMaxVoteWeightSource::SUPPLY_FRACTION_BASE / 2,
+        realm.config.community_mint_max_voter_weight_source =
+            MintMaxVoterWeightSource::SupplyFraction(
+                MintMaxVoterWeightSource::SUPPLY_FRACTION_BASE / 2,
             );
 
         // vote above reduced supply