Governance: Proposal deposit (#135)

* 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

* feat: Add extra_lamports to create_and_serialize_account

* chore: Make Clippy happy

* feat: Implement Proposal security deposit

* chore: Make Clippy happy

* chore: Add proposal deposit amount tests

* feat: Implement RefundProposalDeposit

* chore: test_refund_proposal_deposit

* chore: Make Clippy happy

* chore: test_refund_proposal_deposit_with_cannot_refund_draft_proposal_error

* chore: test_refund_proposal_deposit_with_invalid_proposal_owner_record_error

* chore: test_refund_proposal_deposit_with_invalid_proposal_owner_error

* fix: Return deposit to deposit payer

* chore: Cleanup

* chore: test_refund_proposal_deposit_with_invalid_proposal_deposit_account_error

* fix: Remove unnecessary max(1) for account lamports

Author: SebastianBor

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

@@ -11,7 +11,9 @@ use spl_governance::{
     },
     state::{
         enums::{MintMaxVoterWeightSource, VoteThreshold},
-        governance::{get_governance_address, GovernanceConfig},
+        governance::{
+            get_governance_address, GovernanceConfig, DEFAULT_DEPOSIT_EXEMPT_PROPOSAL_COUNT,
+        },
         proposal::{get_proposal_address, VoteType},
         realm::{get_realm_address, GoverningTokenConfigAccountArgs},
         realm_config::GoverningTokenType,
@@ -197,7 +199,7 @@ impl GovernanceChatProgramTest {
             council_vote_tipping: spl_governance::state::enums::VoteTipping::Strict,
             community_veto_vote_threshold: VoteThreshold::YesVotePercentage(55),
             voting_cool_off_time: 1,
-            reserved: 0,
+            deposit_exempt_proposal_count: DEFAULT_DEPOSIT_EXEMPT_PROPOSAL_COUNT,
         };
 
         let token_owner_record_address = get_token_owner_record_address(

governance/program/src/error.rs

@@ -442,6 +442,14 @@ pub enum GovernanceError {
     /// Vote not allowed in cool off time
     #[error("Vote not allowed in cool off time")]
     VoteNotAllowedInCoolOffTime, // 606
+
+    /// Cannot refund ProposalDeposit
+    #[error("Cannot refund ProposalDeposit")]
+    CannotRefundProposalDeposit, // 607
+
+    /// Invalid ProposalDeposit account address
+    #[error("Invalid ProposalDeposit account address")]
+    InvalidProposalDepositAccountAddress, // 608
 }
 
 impl PrintProgramError for GovernanceError {

governance/program/src/instruction.rs

@@ -10,6 +10,7 @@ use crate::{
         native_treasury::get_native_treasury_address,
         program_metadata::get_program_metadata_address,
         proposal::{get_proposal_address, VoteType},
+        proposal_deposit::get_proposal_deposit_address,
         proposal_transaction::{get_proposal_transaction_address, InstructionData},
         realm::{
             get_governing_token_holding_address, get_realm_address,
@@ -174,6 +175,9 @@ pub enum GovernanceInstruction {
     ///   7. `[]` System program
     ///   8. `[]` RealmConfig account. PDA seeds: ['realm-config', realm]
     ///   9. `[]` Optional Voter Weight Record
+    ///   10.`[writable]` Optional ProposalDeposit account. PDA seeds: ['proposal-deposit', proposal, deposit payer]
+    ///       Proposal deposit is required when there are more active proposals than the configured deposit exempt amount
+    ///       The deposit is paid by the Payer of the transaction and can be reclaimed using RefundProposalDeposit once the Proposal is no longer active
     CreateProposal {
         #[allow(dead_code)]
         /// UTF-8 encoded name of the proposal
@@ -509,6 +513,14 @@ pub enum GovernanceInstruction {
         #[allow(dead_code)]
         amount: u64,
     },
+
+    /// Refunds ProposalDeposit once the given proposal is no longer active (Draft, SigningOff, Voting)
+    /// Once the condition is met the instruction is permissionless and returns the deposit amount to the deposit payer
+    ///
+    ///   0. `[]` Proposal account
+    ///   1. `[writable]` ProposalDeposit account. PDA seeds: ['proposal-deposit', proposal, deposit payer]
+    ///   2. `[writable]` Proposal deposit payer (beneficiary) account
+    RefundProposalDeposit {},
 }
 
 /// Creates CreateRealm instruction
@@ -919,6 +931,12 @@ pub fn create_proposal(
 
     with_realm_config_accounts(program_id, &mut accounts, realm, voter_weight_record, None);
 
+    // Deposit is only required when there are more active proposal then the configured exempt amount
+    // Note: We always pass the account because the actual value is not known here without passing Governance account data
+    let proposal_deposit_address =
+        get_proposal_deposit_address(program_id, &proposal_address, payer);
+    accounts.push(AccountMeta::new(proposal_deposit_address, false));
+
     let instruction = GovernanceInstruction::CreateProposal {
         name,
         description_link,
@@ -1613,3 +1631,30 @@ pub fn with_governing_token_config_args(
         token_type: governing_token_config_args.token_type,
     }
 }
+
+/// Creates RefundProposalDeposit instruction
+#[allow(clippy::too_many_arguments)]
+pub fn refund_proposal_deposit(
+    program_id: &Pubkey,
+    // Accounts
+    proposal: &Pubkey,
+    proposal_deposit_payer: &Pubkey,
+    // Args
+) -> Instruction {
+    let proposal_deposit_address =
+        get_proposal_deposit_address(program_id, proposal, proposal_deposit_payer);
+
+    let accounts = vec![
+        AccountMeta::new_readonly(*proposal, false),
+        AccountMeta::new(proposal_deposit_address, false),
+        AccountMeta::new(*proposal_deposit_payer, false),
+    ];
+
+    let instruction = GovernanceInstruction::RefundProposalDeposit {};
+
+    Instruction {
+        program_id: *program_id,
+        accounts,
+        data: instruction.try_to_vec().unwrap(),
+    }
+}

governance/program/src/processor/mod.rs

@@ -16,6 +16,7 @@ mod process_execute_transaction;
 mod process_finalize_vote;
 mod process_flag_transaction_error;
 mod process_insert_transaction;
+mod process_refund_proposal_deposit;
 mod process_relinquish_vote;
 mod process_remove_signatory;
 mod process_remove_transaction;
@@ -46,6 +47,7 @@ use process_execute_transaction::*;
 use process_finalize_vote::*;
 use process_flag_transaction_error::*;
 use process_insert_transaction::*;
+use process_refund_proposal_deposit::*;
 use process_relinquish_vote::*;
 use process_remove_signatory::*;
 use process_remove_transaction::*;
@@ -221,5 +223,9 @@ pub fn process_instruction(
         GovernanceInstruction::RevokeGoverningTokens { amount } => {
             process_revoke_governing_tokens(program_id, accounts, amount)
         }
+
+        GovernanceInstruction::RefundProposalDeposit {} => {
+            process_refund_proposal_deposit(program_id, accounts)
+        }
     }
 }

governance/program/src/processor/process_add_signatory.rs

@@ -62,6 +62,7 @@ pub fn process_add_signatory(
         program_id,
         system_info,
         &rent,
+        None,
     )?;
 
     proposal_data.signatories_count = proposal_data.signatories_count.checked_add(1).unwrap();

governance/program/src/processor/process_cast_vote.rs

@@ -214,6 +214,7 @@ pub fn process_cast_vote(
         program_id,
         system_info,
         &rent,
+        None,
     )?;
 
     Ok(())

governance/program/src/processor/process_create_governance.rs

@@ -72,6 +72,7 @@ pub fn process_create_governance(
         program_id,
         system_info,
         &rent,
+        None,
     )?;
 
     Ok(())

governance/program/src/processor/process_create_mint_governance.rs

@@ -82,6 +82,7 @@ pub fn process_create_mint_governance(
         program_id,
         system_info,
         &rent,
+        None,
     )?;
 
     if transfer_mint_authorities {

governance/program/src/processor/process_create_native_treasury.rs

@@ -42,6 +42,7 @@ pub fn process_create_native_treasury(
         &system_program::id(), // System program as the PDA owner
         system_info,
         &rent,
+        None,
     )?;
 
     Ok(())

governance/program/src/processor/process_create_program_governance.rs

@@ -84,6 +84,7 @@ pub fn process_create_program_governance(
         program_id,
         system_info,
         &rent,
+        None,
     )?;
 
     if transfer_upgrade_authority {