Governance: Min tokens to create governance (#2203)

* feat: add min_community_tokens_to_create_governance to config

* feat: add token owner record and governing mint to CreateAccountGovernance

* feat: add token owner record and governing mint to CreateMinGovernance

* feat: add token owner record and governing mint to CreateProgramGovernance

* feat: add token owner record and governing mint to CreateTokenGovernance

* feat: remove custodian

* fix: remove mint and update comments

* chore: make clippy happy

* chore: make clippy happy

Author: SebastianBor

Cargo.lock

@@ -50,7 +50,7 @@ pub enum GovernanceInstruction {
     /// 5. `[]` System
     /// 6. `[]` SPL Token
     /// 7. `[]` Sysvar Rent
-    /// 8. `[]` Realm custodian - optional    
+
     /// 9. `[]` Council Token Mint - optional
     /// 10. `[writable]` Council Token Holding account - optional unless council is used. PDA seeds: ['governance',realm,council_mint]
     ///     The account will be created with the Realm PDA as its owner
@@ -109,10 +109,11 @@ pub enum GovernanceInstruction {
     ///
     ///   0. `[]` Realm account the created Governance belongs to
     ///   1. `[writable]` Account Governance account. PDA seeds: ['account-governance', realm, governed_account]
-    ///   2. `[]` Account governed by this Governance account
-    ///   3. `[signer]` Payer
-    ///   4. `[]` System program
-    ///   5. `[]` Sysvar Rent
+    ///   2. `[]` Account governed by this Governance
+    ///   3. `[]` Governing TokenOwnerRecord account
+    ///   4. `[signer]` Payer
+    ///   5. `[]` System program
+    ///   6. `[]` Sysvar Rent
     CreateAccountGovernance {
         /// Governance config
         #[allow(dead_code)]
@@ -126,10 +127,11 @@ pub enum GovernanceInstruction {
     ///   2. `[]` Program governed by this Governance account
     ///   3. `[writable]` Program Data account of the Program governed by this Governance account
     ///   4. `[signer]` Current Upgrade Authority account of the Program governed by this Governance account
-    ///   5. `[signer]` Payer
-    ///   6. `[]` bpf_upgradeable_loader program
-    ///   7. `[]` System program
-    ///   8. `[]` Sysvar Rent
+    ///   5. `[]` Governing TokenOwnerRecord account     
+    ///   6. `[signer]` Payer
+    ///   7. `[]` bpf_upgradeable_loader program
+    ///   8. `[]` System program
+    ///   9. `[]` Sysvar Rent
     CreateProgramGovernance {
         /// Governance config
         #[allow(dead_code)]
@@ -310,10 +312,11 @@ pub enum GovernanceInstruction {
     ///   1. `[writable]` Mint Governance account. PDA seeds: ['mint-governance', realm, governed_mint]
     ///   2. `[writable]` Mint governed by this Governance account
     ///   3. `[signer]` Current Mint Authority
-    ///   4. `[signer]` Payer
-    ///   5. `[]` SPL Token program
-    ///   6. `[]` System program
-    ///   7. `[]` Sysvar Rent
+    ///   4. `[]` Governing TokenOwnerRecord account    
+    ///   5. `[signer]` Payer
+    ///   6. `[]` SPL Token program
+    ///   7. `[]` System program
+    ///   8. `[]` Sysvar Rent
     CreateMintGovernance {
         #[allow(dead_code)]
         /// Governance config
@@ -331,11 +334,12 @@ pub enum GovernanceInstruction {
     ///   0. `[]` Realm account the created Governance belongs to    
     ///   1. `[writable]` Token Governance account. PDA seeds: ['token-governance', realm, governed_token]
     ///   2. `[writable]` Token account governed by this Governance account
-    ///   3. `[signer]` Current Token account owner
-    ///   4. `[signer]` Payer
-    ///   5. `[]` SPL Token program
-    ///   6. `[]` System program
-    ///   7. `[]` Sysvar Rent
+    ///   3. `[signer]` Current Token account
+    ///   4. `[]` Governing TokenOwnerRecord account        
+    ///   5. `[signer]` Payer
+    ///   6. `[]` SPL Token program
+    ///   7. `[]` System program
+    ///   8. `[]` Sysvar Rent
     CreateTokenGovernance {
         #[allow(dead_code)]
         /// Governance config
@@ -383,7 +387,7 @@ pub enum GovernanceInstruction {
     /// Sets realm config
     ///   0. `[writable]` Realm account
     ///   1. `[signer]`  Realm authority    
-    ///   2. `[]` Realm custodian - optional    
+
     ///   3. `[]` Council Token Mint - optional
     ///       Note: In the current version it's only possible to remove council mint (set it to None)
     ///       After setting council to None it won't be possible to withdraw the tokens from the Realm any longer
@@ -405,10 +409,10 @@ pub fn create_realm(
     realm_authority: &Pubkey,
     community_token_mint: &Pubkey,
     payer: &Pubkey,
-    realm_custodian: Option<Pubkey>,
     council_token_mint: Option<Pubkey>,
     // Args
     name: String,
+    min_community_tokens_to_create_governance: u64,
     community_mint_max_vote_weight_source: MintMaxVoteWeightSource,
 ) -> Instruction {
     let realm_address = get_realm_address(program_id, &name);
@@ -426,13 +430,6 @@ pub fn create_realm(
         AccountMeta::new_readonly(sysvar::rent::id(), false),
     ];
 
-    let use_custodian = if let Some(realm_custodian) = realm_custodian {
-        accounts.push(AccountMeta::new_readonly(realm_custodian, false));
-        true
-    } else {
-        false
-    };
-
     let use_council_mint = if let Some(council_token_mint) = council_token_mint {
         let council_token_holding_address =
             get_governing_token_holding_address(program_id, &realm_address, &council_token_mint);
@@ -447,7 +444,7 @@ pub fn create_realm(
     let instruction = GovernanceInstruction::CreateRealm {
         config_args: RealmConfigArgs {
             use_council_mint,
-            use_custodian,
+            min_community_tokens_to_create_governance,
             community_mint_max_vote_weight_source,
         },
         name,
@@ -582,6 +579,7 @@ pub fn create_account_governance(
     // Accounts
     realm: &Pubkey,
     governed_account: &Pubkey,
+    token_owner_record: &Pubkey,
     payer: &Pubkey,
     // Args
     config: GovernanceConfig,
@@ -593,6 +591,7 @@ pub fn create_account_governance(
         AccountMeta::new_readonly(*realm, false),
         AccountMeta::new(account_governance_address, false),
         AccountMeta::new_readonly(*governed_account, false),
+        AccountMeta::new_readonly(*token_owner_record, false),
         AccountMeta::new_readonly(*payer, true),
         AccountMeta::new_readonly(system_program::id(), false),
         AccountMeta::new_readonly(sysvar::rent::id(), false),
@@ -608,12 +607,14 @@ pub fn create_account_governance(
 }
 
 /// Creates CreateProgramGovernance instruction
+#[allow(clippy::too_many_arguments)]
 pub fn create_program_governance(
     program_id: &Pubkey,
     // Accounts
     realm: &Pubkey,
     governed_program: &Pubkey,
     governed_program_upgrade_authority: &Pubkey,
+    token_owner_record: &Pubkey,
     payer: &Pubkey,
     // Args
     config: GovernanceConfig,
@@ -629,6 +630,7 @@ pub fn create_program_governance(
         AccountMeta::new_readonly(*governed_program, false),
         AccountMeta::new(governed_program_data_address, false),
         AccountMeta::new_readonly(*governed_program_upgrade_authority, true),
+        AccountMeta::new_readonly(*token_owner_record, false),
         AccountMeta::new_readonly(*payer, true),
         AccountMeta::new_readonly(bpf_loader_upgradeable::id(), false),
         AccountMeta::new_readonly(system_program::id(), false),
@@ -647,13 +649,15 @@ pub fn create_program_governance(
     }
 }
 
-/// Creates CreateMintGovernance instruction
+/// Creates CreateMintGovernance
+#[allow(clippy::too_many_arguments)]
 pub fn create_mint_governance(
     program_id: &Pubkey,
     // Accounts
     realm: &Pubkey,
     governed_mint: &Pubkey,
     governed_mint_authority: &Pubkey,
+    token_owner_record: &Pubkey,
     payer: &Pubkey,
     // Args
     config: GovernanceConfig,
@@ -666,6 +670,7 @@ pub fn create_mint_governance(
         AccountMeta::new(mint_governance_address, false),
         AccountMeta::new(*governed_mint, false),
         AccountMeta::new_readonly(*governed_mint_authority, true),
+        AccountMeta::new_readonly(*token_owner_record, false),
         AccountMeta::new_readonly(*payer, true),
         AccountMeta::new_readonly(spl_token::id(), false),
         AccountMeta::new_readonly(system_program::id(), false),
@@ -685,12 +690,14 @@ pub fn create_mint_governance(
 }
 
 /// Creates CreateTokenGovernance instruction
+#[allow(clippy::too_many_arguments)]
 pub fn create_token_governance(
     program_id: &Pubkey,
     // Accounts
     realm: &Pubkey,
     governed_token: &Pubkey,
     governed_token_owner: &Pubkey,
+    token_owner_record: &Pubkey,
     payer: &Pubkey,
     // Args
     config: GovernanceConfig,
@@ -703,6 +710,7 @@ pub fn create_token_governance(
         AccountMeta::new(token_governance_address, false),
         AccountMeta::new(*governed_token, false),
         AccountMeta::new_readonly(*governed_token_owner, true),
+        AccountMeta::new_readonly(*token_owner_record, false),
         AccountMeta::new_readonly(*payer, true),
         AccountMeta::new_readonly(spl_token::id(), false),
         AccountMeta::new_readonly(system_program::id(), false),
@@ -1159,22 +1167,16 @@ pub fn set_realm_config(
     realm: &Pubkey,
     realm_authority: &Pubkey,
     council_token_mint: Option<Pubkey>,
-    realm_custodian: Option<Pubkey>,
+
     // Args
+    min_community_tokens_to_create_governance: u64,
     community_mint_max_vote_weight_source: MintMaxVoteWeightSource,
 ) -> Instruction {
     let mut accounts = vec![
         AccountMeta::new(*realm, false),
         AccountMeta::new_readonly(*realm_authority, true),
     ];
 
-    let use_custodian = if let Some(realm_custodian) = realm_custodian {
-        accounts.push(AccountMeta::new_readonly(realm_custodian, false));
-        true
-    } else {
-        false
-    };
-
     let use_council_mint = if let Some(council_token_mint) = council_token_mint {
         let council_token_holding_address =
             get_governing_token_holding_address(program_id, realm, &council_token_mint);
@@ -1189,7 +1191,7 @@ pub fn set_realm_config(
     let instruction = GovernanceInstruction::SetRealmConfig {
         config_args: RealmConfigArgs {
             use_council_mint,
-            use_custodian,
+            min_community_tokens_to_create_governance,
             community_mint_max_vote_weight_source,
         },
     };

governance/program/src/instruction.rs

@@ -29,10 +29,13 @@ pub fn process_create_account_governance(
     let realm_info = next_account_info(account_info_iter)?; // 0
     let account_governance_info = next_account_info(account_info_iter)?; // 1
     let governed_account_info = next_account_info(account_info_iter)?; // 2
-    let payer_info = next_account_info(account_info_iter)?; // 3
-    let system_info = next_account_info(account_info_iter)?; // 4
 
-    let rent_sysvar_info = next_account_info(account_info_iter)?; // 5
+    let _token_owner_record_info = next_account_info(account_info_iter)?; // 3
+
+    let payer_info = next_account_info(account_info_iter)?; // 4
+    let system_info = next_account_info(account_info_iter)?; // 5
+
+    let rent_sysvar_info = next_account_info(account_info_iter)?; // 6
     let rent = &Rent::from_account_info(rent_sysvar_info)?;
 
     assert_valid_create_governance_args(program_id, &config, realm_info)?;

governance/program/src/processor/process_create_account_governance.rs

@@ -36,12 +36,14 @@ pub fn process_create_mint_governance(
     let governed_mint_info = next_account_info(account_info_iter)?; // 2
     let governed_mint_authority_info = next_account_info(account_info_iter)?; // 3
 
-    let payer_info = next_account_info(account_info_iter)?; // 4
-    let spl_token_info = next_account_info(account_info_iter)?; // 5
+    let _token_owner_record_info = next_account_info(account_info_iter)?; // 4
 
-    let system_info = next_account_info(account_info_iter)?; // 6
+    let payer_info = next_account_info(account_info_iter)?; // 5
+    let spl_token_info = next_account_info(account_info_iter)?; // 6
 
-    let rent_sysvar_info = next_account_info(account_info_iter)?; // 7
+    let system_info = next_account_info(account_info_iter)?; // 7
+
+    let rent_sysvar_info = next_account_info(account_info_iter)?; // 8
     let rent = &Rent::from_account_info(rent_sysvar_info)?;
 
     assert_valid_create_governance_args(program_id, &config, realm_info)?;

governance/program/src/processor/process_create_mint_governance.rs

@@ -40,12 +40,14 @@ pub fn process_create_program_governance(
     let governed_program_data_info = next_account_info(account_info_iter)?; // 2
     let governed_program_upgrade_authority_info = next_account_info(account_info_iter)?; // 3
 
-    let payer_info = next_account_info(account_info_iter)?; // 4
-    let bpf_upgrade_loader_info = next_account_info(account_info_iter)?; // 5
+    let _token_owner_record_info = next_account_info(account_info_iter)?; // 4
 
-    let system_info = next_account_info(account_info_iter)?; // 6
+    let payer_info = next_account_info(account_info_iter)?; // 5
+    let bpf_upgrade_loader_info = next_account_info(account_info_iter)?; // 6
 
-    let rent_sysvar_info = next_account_info(account_info_iter)?; // 7
+    let system_info = next_account_info(account_info_iter)?; // 7
+
+    let rent_sysvar_info = next_account_info(account_info_iter)?; // 8
     let rent = &Rent::from_account_info(rent_sysvar_info)?;
 
     assert_valid_create_governance_args(program_id, &config, realm_info)?;

governance/program/src/processor/process_create_program_governance.rs

@@ -61,13 +61,6 @@ pub fn process_create_realm(
         rent,
     )?;
 
-    let realm_custodian = if config_args.use_custodian {
-        let realm_custodian_info = next_account_info(account_info_iter)?;
-        Some(*realm_custodian_info.key)
-    } else {
-        None
-    };
-
     let council_token_mint_address = if config_args.use_council_mint {
         let council_token_mint_info = next_account_info(account_info_iter)?;
         let council_token_holding_info = next_account_info(account_info_iter)?;
@@ -100,9 +93,10 @@ pub fn process_create_realm(
         config: RealmConfig {
             council_mint: council_token_mint_address,
             reserved: [0; 8],
-            custodian: realm_custodian,
             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,
         },
     };
 

governance/program/src/processor/process_create_realm.rs

@@ -36,12 +36,14 @@ pub fn process_create_token_governance(
     let governed_token_info = next_account_info(account_info_iter)?; // 2
     let governed_token_owner_info = next_account_info(account_info_iter)?; // 3
 
-    let payer_info = next_account_info(account_info_iter)?; // 4
-    let spl_token_info = next_account_info(account_info_iter)?; // 5
+    let _token_owner_record_info = next_account_info(account_info_iter)?; // 4
 
-    let system_info = next_account_info(account_info_iter)?; // 6
+    let payer_info = next_account_info(account_info_iter)?; // 5
+    let spl_token_info = next_account_info(account_info_iter)?; // 6
 
-    let rent_sysvar_info = next_account_info(account_info_iter)?; // 7
+    let system_info = next_account_info(account_info_iter)?; // 7
+
+    let rent_sysvar_info = next_account_info(account_info_iter)?; // 8
     let rent = &Rent::from_account_info(rent_sysvar_info)?;
 
     assert_valid_create_governance_args(program_id, &config, realm_info)?;

governance/program/src/processor/process_create_token_governance.rs

@@ -32,13 +32,6 @@ pub fn process_set_realm_config(
 
     assert_valid_realm_config_args(&config_args)?;
 
-    let realm_custodian = if config_args.use_custodian {
-        let realm_custodian_info = next_account_info(account_info_iter)?;
-        Some(*realm_custodian_info.key)
-    } else {
-        None
-    };
-
     if config_args.use_council_mint {
         let council_token_mint_info = next_account_info(account_info_iter)?;
 
@@ -60,9 +53,10 @@ pub fn process_set_realm_config(
         realm_data.config.council_mint = None;
     }
 
-    realm_data.config.custodian = realm_custodian;
     realm_data.config.community_mint_max_vote_weight_source =
         config_args.community_mint_max_vote_weight_source;
+    realm_data.config.min_community_tokens_to_create_governance =
+        config_args.min_community_tokens_to_create_governance;
 
     realm_data.serialize(&mut *realm_info.data.borrow_mut())?;
 

governance/program/src/processor/process_set_realm_config.rs

@@ -562,9 +562,10 @@ mod test {
             config: RealmConfig {
                 council_mint: Some(Pubkey::new_unique()),
                 reserved: [0; 8],
-                custodian: Some(Pubkey::new_unique()),
+
                 community_mint_max_vote_weight_source:
                     MintMaxVoteWeightSource::FULL_SUPPLY_FRACTION,
+                min_community_tokens_to_create_governance: 10,
             },
         }
     }