client-rust: deprecate ConfigState

Author: buffalojoec

clients/rust/src/instructions_bincode.rs

@@ -11,25 +11,27 @@ use {
 };
 
 /// Trait defining config state to be stored at the end of the account data.
+#[deprecated(since = "1.0.0", note = "This trait is no longer supported")]
 pub trait ConfigState: serde::Serialize + Default {
     /// Maximum space that the serialized representation will require
     fn max_space() -> u64;
 }
 
-fn initialize_account<T: ConfigState>(config_pubkey: &Pubkey) -> Instruction {
+fn initialize_account<T: Default + serde::Serialize>(config_pubkey: &Pubkey) -> Instruction {
     let account_metas = vec![AccountMeta::new(*config_pubkey, true)];
     let account_data = (ConfigKeys { keys: vec![] }, T::default());
     Instruction::new_with_bincode(ID, &account_data, account_metas)
 }
 
 /// Create a new, empty configuration account
-pub fn create_account<T: ConfigState>(
+pub fn create_account<T: Default + serde::Serialize>(
     from_account_pubkey: &Pubkey,
     config_account_pubkey: &Pubkey,
     lamports: u64,
+    max_space: u64,
     keys: Vec<(Pubkey, bool)>,
 ) -> Vec<Instruction> {
-    let space = T::max_space().saturating_add(serialized_size(&ConfigKeys { keys }).unwrap());
+    let space = max_space.saturating_add(serialized_size(&ConfigKeys { keys }).unwrap());
     vec![
         system_instruction::create_account(
             from_account_pubkey,
@@ -43,7 +45,7 @@ pub fn create_account<T: ConfigState>(
 }
 
 /// Store new data in a configuration account
-pub fn store<T: ConfigState>(
+pub fn store<T: serde::Serialize>(
     config_account_pubkey: &Pubkey,
     is_config_signer: bool,
     keys: Vec<(Pubkey, bool)>,

program/benches/setup.rs

@@ -2,7 +2,7 @@ use {
     mollusk_svm_bencher::Bench,
     serde::Serialize,
     solana_config_program::state::ConfigKeys,
-    solana_config_program_client::instructions_bincode::{store, ConfigState},
+    solana_config_program_client::instructions_bincode::store,
     solana_sdk::{
         account::Account,
         hash::Hash,
@@ -28,17 +28,17 @@ impl BenchContext {
 
 /// Trait to avoid re-defining the same instruction and account constructors
 /// for each `ConfigState`.
-pub trait BenchSetup: ConfigState + Default {
+pub trait BenchSetup: Default + serde::Serialize {
     const BENCH_ID: &'static str;
 
     fn default_account_state(keys: Vec<(Pubkey, bool)>) -> (ConfigKeys, Self) {
         (ConfigKeys { keys }, Self::default())
     }
 
     fn default_space(keys: Vec<(Pubkey, bool)>) -> usize {
-        (Self::max_space()
-            .checked_add(bincode::serialized_size(&ConfigKeys { keys }).unwrap())
-            .unwrap()) as usize
+        let config_keys_space = bincode::serialized_size(&ConfigKeys { keys }).unwrap();
+        let config_state_space = bincode::serialized_size(&Self::default()).unwrap();
+        (config_keys_space.checked_add(config_state_space).unwrap()) as usize
     }
 
     fn keys(keys_len: usize) -> Vec<(Pubkey, bool)> {
@@ -103,12 +103,6 @@ pub struct ConfigSmall {
     pub item: u64,
 }
 
-impl ConfigState for ConfigSmall {
-    fn max_space() -> u64 {
-        bincode::serialized_size(&Self::default()).unwrap()
-    }
-}
-
 impl BenchSetup for ConfigSmall {
     const BENCH_ID: &'static str = "config_small";
 }
@@ -119,12 +113,6 @@ pub struct ConfigMedium {
     pub hashes: [Hash; 32], // 32 x 32 = 1024 bytes
 }
 
-impl ConfigState for ConfigMedium {
-    fn max_space() -> u64 {
-        bincode::serialized_size(&Self::default()).unwrap()
-    }
-}
-
 impl BenchSetup for ConfigMedium {
     const BENCH_ID: &'static str = "config_medium";
 }
@@ -135,12 +123,6 @@ pub struct ConfigLarge {
     pub hashes: [[Hash; 32]; 32], // 32 x 32 x 32 = 32_768 bytes
 }
 
-impl ConfigState for ConfigLarge {
-    fn max_space() -> u64 {
-        bincode::serialized_size(&Self::default()).unwrap()
-    }
-}
-
 impl BenchSetup for ConfigLarge {
     const BENCH_ID: &'static str = "config_large";
 }

program/tests/functional.rs

@@ -6,7 +6,7 @@ use {
     mollusk_svm::{result::Check, Mollusk},
     serde::{Deserialize, Serialize},
     solana_config_program::{error::ConfigError, state::ConfigKeys},
-    solana_config_program_client::instructions_bincode::{self as config_instruction, ConfigState},
+    solana_config_program_client::instructions_bincode::{self as config_instruction},
     solana_sdk::{
         account::Account,
         instruction::{AccountMeta, Instruction},
@@ -30,12 +30,6 @@ impl MyConfig {
     }
 }
 
-impl ConfigState for MyConfig {
-    fn max_space() -> u64 {
-        serialized_size(&Self::default()).unwrap()
-    }
-}
-
 fn setup() -> Mollusk {
     Mollusk::new(&solana_config_program::id(), "solana_config_program")
 }
@@ -549,9 +543,15 @@ fn test_config_initialize_no_panic() {
     let mollusk = setup();
 
     let config = Pubkey::new_unique();
+    let max_space = serialized_size(&MyConfig::default()).unwrap();
 
-    let instructions =
-        config_instruction::create_account::<MyConfig>(&Pubkey::new_unique(), &config, 1, vec![]);
+    let instructions = config_instruction::create_account::<MyConfig>(
+        &Pubkey::new_unique(),
+        &config,
+        1,
+        max_space,
+        vec![],
+    );
     let mut instruction = instructions[1].clone();
     instruction.accounts = vec![];