Governance: future proofing for v2 (#2002)

* chore: upgrade instruction serialisation

* chore: add assert for base64 encoded instruction

* chore: move fields with dynamic size to account  end

* chore: Add VoteThresholdPercentageType to support quorum votes in future versions

* chore: Add VoteWeightSource to support account snapshots as voter weights in future versions

* chore: Add InstructionExecutionStatus to support failing proposal instructions in future versions

* fix: update voting_at_slot when proposal enters voting state

* fix: change min_tokens_to_create_proposal to u64 to support large mints

* chore: add InstructionExecutionFlags to support ordered and transactional instruction in future versions

* chore: add withdraw tests with relinquished and unrelinquished votes

* chore: add placeholder for proposal_cool_off_time

* chore: add padding to permanent accounts to use in future versions

* chore: add ProposalCoolOffTimeNotSupported error

* chore: start governance errors from 500

* chore: update versions

* chore: update comments

* chore: use slice for reserved account space

* chore: use VoteThresholdPercentage enum to store percentage value

* chore: use enum None value instead of Option for execution_status

* chore: use enum None instead of Option for execution_flags

* chore: make clippy happy

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

Author: SebastianBor

Cargo.lock

@@ -1,7 +1,7 @@
 [package]
 name = "spl-governance"
-version = "0.1.0"
-description = "Solana Program Library Governance"
+version = "1.0.1"
+description = "Solana Program Library Governance Program"
 authors = ["Solana Maintainers <[email protected]>"]
 repository = "https://github.com/solana-labs/solana-program-library"
 license = "Apache-2.0"
@@ -20,11 +20,12 @@ num-traits = "0.2"
 serde = "1.0.126"
 serde_derive = "1.0.103"
 solana-program = "1.7.4"
-spl-token = { path = "../../token/program", features = [ "no-entrypoint" ] }
+spl-token = { version = "3.1.1", path = "../../token/program", features = [ "no-entrypoint" ] }
 thiserror = "1.0"
 
 [dev-dependencies]
 assert_matches = "1.5.0"
+base64 = "0.13"
 proptest = "1.0"
 solana-program-test = "1.7.4"
 solana-sdk = "1.7.4"

governance/program/Cargo.toml

@@ -13,7 +13,7 @@ use thiserror::Error;
 pub enum GovernanceError {
     /// Invalid instruction passed to program
     #[error("Invalid instruction passed to program")]
-    InvalidInstruction,
+    InvalidInstruction = 500, // Start Governance custom errors from 500 to avoid conflicts with programs invoked via CPI
 
     /// Realm with the given name and governing mints already exists
     #[error("Realm with the given name and governing mints already exists")]
@@ -259,6 +259,18 @@ pub enum GovernanceError {
     /// Current token owner must sign transaction
     #[error("Current token owner must sign transaction")]
     TokenOwnerMustSign,
+
+    /// Given VoteThresholdPercentageType is not supported
+    #[error("Given VoteThresholdPercentageType is not supported")]
+    VoteThresholdPercentageTypeNotSupported,
+
+    /// Given VoteWeightSource is not supported
+    #[error("Given VoteWeightSource is not supported")]
+    VoteWeightSourceNotSupported,
+
+    /// Proposal cool off time is not supported
+    #[error("Proposal cool off time is not supported")]
+    ProposalCoolOffTimeNotSupported,
 }
 
 impl PrintProgramError for GovernanceError {

governance/program/src/error.rs

@@ -40,6 +40,7 @@ pub fn process_create_account_governance(
         account_type: GovernanceAccountType::AccountGovernance,
         config: config.clone(),
         proposals_count: 0,
+        reserved: [0; 8],
     };
 
     create_and_serialize_account_signed::<Governance>(

governance/program/src/processor/process_create_account_governance.rs

@@ -50,6 +50,7 @@ pub fn process_create_mint_governance(
         account_type: GovernanceAccountType::MintGovernance,
         config: config.clone(),
         proposals_count: 0,
+        reserved: [0; 8],
     };
 
     create_and_serialize_account_signed::<Governance>(

governance/program/src/processor/process_create_mint_governance.rs

@@ -53,6 +53,7 @@ pub fn process_create_program_governance(
         account_type: GovernanceAccountType::ProgramGovernance,
         config: config.clone(),
         proposals_count: 0,
+        reserved: [0; 8],
     };
 
     create_and_serialize_account_signed::<Governance>(

governance/program/src/processor/process_create_program_governance.rs

@@ -13,7 +13,7 @@ use solana_program::{
 use crate::{
     error::GovernanceError,
     state::{
-        enums::{GovernanceAccountType, ProposalState},
+        enums::{GovernanceAccountType, InstructionExecutionFlags, ProposalState},
         governance::get_governance_data,
         proposal::{get_proposal_address_seeds, Proposal},
         token_owner_record::get_token_owner_record_data_for_realm_and_governing_mint,
@@ -84,6 +84,7 @@ pub fn process_create_proposal(
         draft_at: clock.unix_timestamp,
         signing_off_at: None,
         voting_at: None,
+        voting_at_slot: None,
         voting_completed_at: None,
         executing_at: None,
         closed_at: None,
@@ -92,6 +93,8 @@ pub fn process_create_proposal(
         instructions_count: 0,
         instructions_next_index: 0,
 
+        execution_flags: InstructionExecutionFlags::None,
+
         yes_votes_count: 0,
         no_votes_count: 0,
     };

governance/program/src/processor/process_create_proposal.rs

@@ -83,6 +83,7 @@ pub fn process_create_realm(
         community_mint: *governance_token_mint_info.key,
         council_mint: council_token_mint_address,
         name: name.clone(),
+        reserved: [0; 8],
     };
 
     create_and_serialize_account_signed::<Realm>(

governance/program/src/processor/process_create_realm.rs

@@ -50,6 +50,7 @@ pub fn process_create_token_governance(
         account_type: GovernanceAccountType::TokenGovernance,
         config: config.clone(),
         proposals_count: 0,
+        reserved: [0; 8],
     };
 
     create_and_serialize_account_signed::<Governance>(

governance/program/src/processor/process_create_token_governance.rs

@@ -87,6 +87,7 @@ pub fn process_deposit_governing_tokens(
             governance_delegate: None,
             unrelinquished_votes_count: 0,
             total_votes_count: 0,
+            reserved: [0; 8],
         };
 
         create_and_serialize_account_signed(