Governance: Veto vote (#3156)

* chore: remove #[repr(C)]

* wip: resolve proposal governing token mint

* fix: remove optionality from veto vote

* feat: implement tipping for veto vote

* fix: move vote_threshold to the end of Proposal struct

* chore: remove use super

* chore: make clippy happy

* chore: add change log

* feat: add council_veto_vote_threshold

* fix: resolve vote threshold for voting token mint

* chore: revert old function name

* fix: calculate max veto in coerce_max_voter_weight

* chore: make clippy happy

* chore: make clippy happy

* feat: Implement RelinquishVote for Veto

* chore: update comments

* chore: rename with_cast_vote to with_cast_yes_no_vote

* chore: rename with_cast_multi_option_vote to with_cast_vote

* chore: create use_veto_vote test scenario

* chore: Add veto vote disabled tests

* chore: Add partial Veto vote tests

* chore: update comments

* chore: test_cast_veto_vote_with_no_council_error

* chore: test_relinquish_veto_vote

* chore: rename with_token_owner_record to with_community_token_owner_record

* chore: test_relinquish_veto_vote_with_vote_record_for_different_voting_mint_error

* chore: test_cast_veto_vote_with_invalid_voting_mint_error

* chore: fix chat build

* chore: test_cast_veto_vote_with_council_only_allowed_to_veto

* fix: Use VoteKind to distinguish between Veto and Electorate votes

* chore: make clippy happy

* Update change log

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

* chore: rename voting_token_mint to vote_governing_token_mint

* chore: test_cast_yes_and_veto_votes_with_yes_as_winning_vote

* fix: throw error for Community veto

* chore: Update comments

* chore: Update names and commnents

* chore: split try_get_tipped_vote_state into Electorate and Veto cases

* chore: Update comments

* chore: remove #[allow(clippy::float_cmp)]

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

Author: SebastianBor

governance/CHANGELOG.md

@@ -0,0 +1,34 @@
+# SPL Governance Changelog
+
+## v3.0.0 - development
+
+- Support separate vote threshold for `Council`
+- `Council` Veto vote
+
+## v2.2.4 - 24 Mar 2022
+
+- Support Anchor native account discriminators for `MaxVoterWeightRecord` and `VoterWeightRecord`
+
+## v2.2.3 - 09 Feb 2022
+
+- Fix serialisation of multiple instructions within a single proposal transaction
+
+## v2.2.2 - 07 Feb 2022
+
+- Native SOL Treasuries
+- Multi choice and survey style proposals
+- `voter_weight` and `max_voter_weight` addins
+- Multiple instructions per proposal transaction
+- Configurable tipping point (`Strict`, `Early`, `Disabled`)
+- Owner signed off proposals
+- `realm_authority` can create governances
+- Program metadata and version detection
+- Custom deposit amount for governance tokens
+
+## v1.1.1 - 23 Sep 2021
+
+- Constrain number of outstanding proposals per token owner to 10 at a time
+
+## v1.0.8 - 1 Aug 2021
+
+- First release

governance/chat/program/src/state.rs

@@ -8,7 +8,6 @@ use solana_program::{
 use spl_governance_tools::account::{assert_is_valid_account_of_type, AccountMaxSize};
 
 /// Defines all GovernanceChat accounts types
-#[repr(C)]
 #[derive(Clone, Debug, PartialEq, BorshDeserialize, BorshSerialize, BorshSchema)]
 pub enum GovernanceChatAccountType {
     /// Default uninitialized account state

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

@@ -186,7 +186,7 @@ impl GovernanceChatProgramTest {
             community_vote_threshold: VoteThreshold::YesVotePercentage(60),
             vote_tipping: spl_governance::state::enums::VoteTipping::Strict,
             council_vote_threshold: VoteThreshold::YesVotePercentage(10),
-            reserved: [0; 2],
+            council_veto_vote_threshold: VoteThreshold::YesVotePercentage(50),
         };
 
         let token_owner_record_address = get_token_owner_record_address(

governance/program/src/error.rs

@@ -25,7 +25,7 @@ pub enum GovernanceError {
 
     /// Invalid Governing Token Mint
     #[error("Invalid Governing Token Mint")]
-    InvalidGoverningTokenMint,
+    InvalidGoverningTokenMint, // 503
 
     /// Governing Token Owner must sign transaction
     #[error("Governing Token Owner must sign transaction")]
@@ -45,11 +45,11 @@ pub enum GovernanceError {
 
     /// Invalid GoverningMint for TokenOwnerRecord
     #[error("Invalid GoverningMint for TokenOwnerRecord")]
-    InvalidGoverningMintForTokenOwnerRecord,
+    InvalidGoverningMintForTokenOwnerRecord, // 508
 
     /// Invalid Realm for TokenOwnerRecord
     #[error("Invalid Realm for TokenOwnerRecord")]
-    InvalidRealmForTokenOwnerRecord,
+    InvalidRealmForTokenOwnerRecord, // 509
 
     /// Invalid Proposal for ProposalTransaction,
     #[error("Invalid Proposal for ProposalTransaction,")]
@@ -164,95 +164,95 @@ pub enum GovernanceError {
 
     /// Proposal does not belong to the given Governance
     #[error("Proposal does not belong to the given Governance")]
-    InvalidGovernanceForProposal,
+    InvalidGovernanceForProposal, // 538
 
     /// Proposal does not belong to given Governing Mint"
     #[error("Proposal does not belong to given Governing Mint")]
-    InvalidGoverningMintForProposal,
+    InvalidGoverningMintForProposal, // 539
 
     /// Current mint authority must sign transaction
     #[error("Current mint authority must sign transaction")]
-    MintAuthorityMustSign,
+    MintAuthorityMustSign, // 540
 
     /// Invalid mint authority
     #[error("Invalid mint authority")]
-    InvalidMintAuthority,
+    InvalidMintAuthority, // 542
 
     /// Mint has no authority
     #[error("Mint has no authority")]
-    MintHasNoAuthority,
+    MintHasNoAuthority, // 542
 
     /// ---- SPL Token Tools Errors ----
 
     /// Invalid Token account owner
     #[error("Invalid Token account owner")]
-    SplTokenAccountWithInvalidOwner,
+    SplTokenAccountWithInvalidOwner, // 543
 
     /// Invalid Mint account owner
     #[error("Invalid Mint account owner")]
-    SplTokenMintWithInvalidOwner,
+    SplTokenMintWithInvalidOwner, // 544
 
     /// Token Account is not initialized
     #[error("Token Account is not initialized")]
-    SplTokenAccountNotInitialized,
+    SplTokenAccountNotInitialized, // 545
 
     /// Token Account doesn't exist
     #[error("Token Account doesn't exist")]
-    SplTokenAccountDoesNotExist,
+    SplTokenAccountDoesNotExist, // 546
 
     /// Token account data is invalid
     #[error("Token account data is invalid")]
-    SplTokenInvalidTokenAccountData,
+    SplTokenInvalidTokenAccountData, // 547
 
     /// Token mint account data is invalid
     #[error("Token mint account data is invalid")]
-    SplTokenInvalidMintAccountData,
+    SplTokenInvalidMintAccountData, // 548
 
     /// Token Mint is not initialized
     #[error("Token Mint account is not initialized")]
-    SplTokenMintNotInitialized,
+    SplTokenMintNotInitialized, // 549
 
     /// Token Mint account doesn't exist
     #[error("Token Mint account doesn't exist")]
-    SplTokenMintDoesNotExist,
+    SplTokenMintDoesNotExist, // 550
 
     /// ---- Bpf Upgradable Loader Tools Errors ----
 
     /// Invalid ProgramData account Address
     #[error("Invalid ProgramData account address")]
-    InvalidProgramDataAccountAddress,
+    InvalidProgramDataAccountAddress, // 551
 
     /// Invalid ProgramData account data
     #[error("Invalid ProgramData account Data")]
-    InvalidProgramDataAccountData,
+    InvalidProgramDataAccountData, // 552
 
     /// Provided upgrade authority doesn't match current program upgrade authority
     #[error("Provided upgrade authority doesn't match current program upgrade authority")]
-    InvalidUpgradeAuthority,
+    InvalidUpgradeAuthority, // 553
 
     /// Current program upgrade authority must sign transaction
     #[error("Current program upgrade authority must sign transaction")]
-    UpgradeAuthorityMustSign,
+    UpgradeAuthorityMustSign, // 554
 
     /// Given program is not upgradable
     #[error("Given program is not upgradable")]
-    ProgramNotUpgradable,
+    ProgramNotUpgradable, // 555
 
     /// Invalid token owner
     #[error("Invalid token owner")]
-    InvalidTokenOwner,
+    InvalidTokenOwner, // 556
 
     /// Current token owner must sign transaction
     #[error("Current token owner must sign transaction")]
-    TokenOwnerMustSign,
+    TokenOwnerMustSign, // 557
 
     /// Given VoteThresholdType is not supported
     #[error("Given VoteThresholdType is not supported")]
-    VoteThresholdTypeNotSupported,
+    VoteThresholdTypeNotSupported, // 558
 
     /// Given VoteWeightSource is not supported
     #[error("Given VoteWeightSource is not supported")]
-    VoteWeightSourceNotSupported,
+    VoteWeightSourceNotSupported, // 559
 
     /// GoverningTokenMint not allowed to vote
     #[error("GoverningTokenMint not allowed to vote")]

governance/program/src/instruction.rs

@@ -30,7 +30,6 @@ use solana_program::{
 
 /// Instructions supported by the Governance program
 #[derive(Clone, Debug, PartialEq, BorshDeserialize, BorshSerialize, BorshSchema)]
-#[repr(C)]
 #[allow(clippy::large_enum_variant)]
 pub enum GovernanceInstruction {
     /// Creates Governance Realm account which aggregates governances for given Community Mint and optional Council Mint
@@ -286,10 +285,14 @@ pub enum GovernanceInstruction {
     ///   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, governing_token_mint, governing_token_owner]
+    ///   4. `[writable]` TokenOwnerRecord of the voter. PDA seeds: ['governance',realm, vote_governing_token_mint, governing_token_owner]
     ///   5. `[signer]` Governance Authority (Token Owner or Governance Delegate)
-    ///   6. `[writable]` Proposal VoteRecord account. PDA seeds: ['governance',proposal,governing_token_owner_record]
-    ///   7. `[]` Governing Token Mint
+    ///   6. `[writable]` Proposal VoteRecord account. PDA seeds: ['governance',proposal,token_owner_record]
+    ///   7. `[]` The Governing Token Mint which is used to cast the vote (vote_governing_token_mint)
+    ///           The voting token mint is the governing_token_mint of the Proposal for Approve, Deny and Abstain votes
+    ///           For Veto vote the voting token mint is the mint of the opposite voting population
+    ///           Council mint to veto Community proposals and Community mint to veto Council proposals
+    ///           Note: In the current version only Council veto is supported
     ///   8. `[signer]` Payer
     ///   9. `[]` System program
     ///   10. `[]` Realm Config
@@ -317,14 +320,15 @@ pub enum GovernanceInstruction {
     ///  If the Proposal is already in decided state then the instruction has no impact on the Proposal
     ///  and only allows voters to prune their outstanding votes in case they wanted to withdraw Governing tokens from the Realm
     ///
-    ///   0. `[]` Governance account
-    ///   1. `[writable]` Proposal account
-    ///   2. `[writable]` TokenOwnerRecord account. PDA seeds: ['governance',realm, governing_token_mint, governing_token_owner]
-    ///   3. `[writable]` Proposal VoteRecord account. PDA seeds: ['governance',proposal,governing_token_owner_record]
-    ///   4. `[]` Governing Token Mint
-    ///   5. `[signer]` Optional Governance Authority (Token Owner or Governance Delegate)
+    ///   0. `[]` Realm account
+    ///   1. `[]` Governance account
+    ///   2. `[writable]` Proposal account
+    ///   3. `[writable]` TokenOwnerRecord account. PDA seeds: ['governance',realm, vote_governing_token_mint, governing_token_owner]
+    ///   4. `[writable]` Proposal VoteRecord account. PDA seeds: ['governance',proposal, token_owner_record]
+    ///   5. `[]` The Governing Token Mint which was used to cast the vote (vote_governing_token_mint)
+    ///   6. `[signer]` Optional Governance Authority (Token Owner or Governance Delegate)
     ///       It's required only when Proposal is still being voted on
-    ///   6. `[writable]` Optional Beneficiary account which would receive lamports when VoteRecord Account is disposed
+    ///   7. `[writable]` Optional Beneficiary account which would receive lamports when VoteRecord Account is disposed
     ///       It's required only when Proposal is still being voted on
     RelinquishVote,
 
@@ -1020,7 +1024,7 @@ pub fn cast_vote(
     proposal_owner_record: &Pubkey,
     voter_token_owner_record: &Pubkey,
     governance_authority: &Pubkey,
-    governing_token_mint: &Pubkey,
+    vote_governing_token_mint: &Pubkey,
     payer: &Pubkey,
     voter_weight_record: Option<Pubkey>,
     max_voter_weight_record: Option<Pubkey>,
@@ -1038,7 +1042,7 @@ pub fn cast_vote(
         AccountMeta::new(*voter_token_owner_record, false),
         AccountMeta::new_readonly(*governance_authority, true),
         AccountMeta::new(vote_record_address, false),
-        AccountMeta::new_readonly(*governing_token_mint, false),
+        AccountMeta::new_readonly(*vote_governing_token_mint, false),
         AccountMeta::new(*payer, true),
         AccountMeta::new_readonly(system_program::id(), false),
     ];
@@ -1097,24 +1101,27 @@ pub fn finalize_vote(
 }
 
 /// Creates RelinquishVote instruction
+#[allow(clippy::too_many_arguments)]
 pub fn relinquish_vote(
     program_id: &Pubkey,
     // Accounts
+    realm: &Pubkey,
     governance: &Pubkey,
     proposal: &Pubkey,
     token_owner_record: &Pubkey,
-    governing_token_mint: &Pubkey,
+    vote_governing_token_mint: &Pubkey,
     governance_authority: Option<Pubkey>,
     beneficiary: Option<Pubkey>,
 ) -> Instruction {
     let vote_record_address = get_vote_record_address(program_id, proposal, token_owner_record);
 
     let mut accounts = vec![
+        AccountMeta::new_readonly(*realm, false),
         AccountMeta::new_readonly(*governance, false),
         AccountMeta::new(*proposal, false),
         AccountMeta::new(*token_owner_record, false),
         AccountMeta::new(vote_record_address, false),
-        AccountMeta::new_readonly(*governing_token_mint, false),
+        AccountMeta::new_readonly(*vote_governing_token_mint, false),
     ];
 
     if let Some(governance_authority) = governance_authority {

governance/program/src/processor/process_cast_vote.rs

@@ -22,7 +22,7 @@ use crate::{
             get_token_owner_record_data_for_proposal_owner,
             get_token_owner_record_data_for_realm_and_governing_mint,
         },
-        vote_record::{get_vote_record_address_seeds, Vote, VoteRecordV2},
+        vote_record::{get_vote_kind, get_vote_record_address_seeds, Vote, VoteRecordV2},
     },
 };
 
@@ -44,7 +44,7 @@ pub fn process_cast_vote(
     let governance_authority_info = next_account_info(account_info_iter)?; // 5
 
     let vote_record_info = next_account_info(account_info_iter)?; // 6
-    let governing_token_mint_info = next_account_info(account_info_iter)?; // 7
+    let vote_governing_token_mint_info = next_account_info(account_info_iter)?; // 7
 
     let payer_info = next_account_info(account_info_iter)?; // 8
     let system_info = next_account_info(account_info_iter)?; // 9
@@ -59,16 +59,27 @@ pub fn process_cast_vote(
     let mut realm_data = get_realm_data_for_governing_token_mint(
         program_id,
         realm_info,
-        governing_token_mint_info.key,
+        vote_governing_token_mint_info.key,
     )?;
+
     let mut governance_data =
         get_governance_data_for_realm(program_id, governance_info, realm_info.key)?;
 
+    let vote_kind = get_vote_kind(&vote);
+
+    // Get the governing_token_mint which the Proposal should be configured with as the voting population for the given vote
+    // For Approve, Deny and Abstain votes it's the same as vote_governing_token_mint
+    // For Veto it's the governing token mint of the opposite voting population
+    let proposal_governing_token_mint = realm_data.get_proposal_governing_token_mint_for_vote(
+        vote_governing_token_mint_info.key,
+        &vote_kind,
+    )?;
+
     let mut proposal_data = get_proposal_data_for_governance_and_governing_mint(
         program_id,
         proposal_info,
         governance_info.key,
-        governing_token_mint_info.key,
+        &proposal_governing_token_mint,
     )?;
     proposal_data.assert_can_cast_vote(&governance_data.config, clock.unix_timestamp)?;
 
@@ -77,7 +88,7 @@ pub fn process_cast_vote(
             program_id,
             voter_token_owner_record_info,
             &governance_data.realm,
-            governing_token_mint_info.key,
+            vote_governing_token_mint_info.key,
         )?;
     voter_token_owner_record_data
         .assert_token_owner_or_delegate_is_signer(governance_authority_info)?;
@@ -129,28 +140,39 @@ pub fn process_cast_vote(
                     .unwrap(),
             )
         }
-        Vote::Abstain | Vote::Veto => {
+        Vote::Veto => {
+            proposal_data.veto_vote_weight = proposal_data
+                .veto_vote_weight
+                .checked_add(voter_weight)
+                .unwrap();
+        }
+        Vote::Abstain => {
             return Err(GovernanceError::NotSupportedVoteType.into());
         }
     }
 
     let max_voter_weight = proposal_data.resolve_max_voter_weight(
         program_id,
         realm_config_info,
-        governing_token_mint_info,
+        vote_governing_token_mint_info,
         account_info_iter, // max_voter_weight_record  11
         realm_info.key,
         &realm_data,
+        &vote_kind,
     )?;
 
-    let vote_threshold =
-        governance_data.resolve_vote_threshold(&realm_data, governing_token_mint_info.key)?;
+    let vote_threshold = governance_data.resolve_vote_threshold(
+        &realm_data,
+        vote_governing_token_mint_info.key,
+        &vote_kind,
+    )?;
 
     if proposal_data.try_tip_vote(
         max_voter_weight,
-        &governance_data.config,
+        &governance_data.config.vote_tipping,
         clock.unix_timestamp,
         &vote_threshold,
+        &vote_kind,
     )? {
         // Deserialize proposal owner and validate it's the actual owner of the proposal
         let mut proposal_owner_record_data = get_token_owner_record_data_for_proposal_owner(