client: deprecate instructions_bincode

Author: buffalojoec

Cargo.lock

@@ -42,6 +42,5 @@ solana-pubkey = "2.2.1"
 solana-sdk = "2.2.1"
 solana-sdk-ids = "2.2.1"
 solana-short-vec = "2.2.1"
-solana-stake-interface = "1.2.1"
 solana-system-interface = "1.0.0"
 thiserror = "1.0.61"

Cargo.toml

@@ -10,7 +10,13 @@ edition = { workspace = true }
 
 [features]
 fetch = ["dep:solana-client", "dep:solana-sdk"]
-serde = ["dep:bincode", "dep:serde", "kaigan/serde"]
+serde = [
+    "dep:bincode", 
+    "dep:serde", 
+    "dep:solana-config-interface", 
+    "kaigan/serde", 
+    "solana-config-interface/bincode"
+]
 test-sbf = []
 
 [dependencies]
@@ -19,6 +25,7 @@ borsh = { workspace = true }
 kaigan = { workspace = true }
 serde = { workspace = true, features = ["derive"], optional = true }
 solana-client = { workspace = true, optional = true }
+solana-config-interface = { workspace = true, optional = true }
 solana-program = { workspace = true, features = ["borsh"] }
 solana-sdk = { workspace = true, optional = true }
 

clients/rust/Cargo.toml

@@ -1,14 +1,7 @@
 //! Program instruction helpers.
 
-use {
-    crate::{ConfigKeys, ID},
-    bincode::serialized_size,
-    solana_program::{
-        instruction::{AccountMeta, Instruction},
-        pubkey::Pubkey,
-        system_instruction,
-    },
-};
+pub use solana_config_interface::instruction::{create_account_with_max_config_space, store};
+use solana_program::{instruction::Instruction, pubkey::Pubkey};
 
 /// 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")]
@@ -17,12 +10,6 @@ pub trait ConfigState: serde::Serialize + Default {
     fn max_space() -> u64;
 }
 
-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
 #[deprecated(
     since = "1.0.0",
@@ -43,41 +30,3 @@ pub fn create_account<T: ConfigState>(
         keys,
     )
 }
-
-/// Create a new, empty configuration account
-pub fn create_account_with_max_config_space<T: Default + serde::Serialize>(
-    from_account_pubkey: &Pubkey,
-    config_account_pubkey: &Pubkey,
-    lamports: u64,
-    max_config_space: u64,
-    keys: Vec<(Pubkey, bool)>,
-) -> Vec<Instruction> {
-    let space = max_config_space.saturating_add(serialized_size(&ConfigKeys { keys }).unwrap());
-    vec![
-        system_instruction::create_account(
-            from_account_pubkey,
-            config_account_pubkey,
-            lamports,
-            space,
-            &ID,
-        ),
-        initialize_account::<T>(config_account_pubkey),
-    ]
-}
-
-/// Store new data in a configuration account
-pub fn store<T: serde::Serialize>(
-    config_account_pubkey: &Pubkey,
-    is_config_signer: bool,
-    keys: Vec<(Pubkey, bool)>,
-    data: &T,
-) -> Instruction {
-    let mut account_metas = vec![AccountMeta::new(*config_account_pubkey, is_config_signer)];
-    for (signer_pubkey, _) in keys.iter().filter(|(_, is_signer)| *is_signer) {
-        if signer_pubkey != config_account_pubkey {
-            account_metas.push(AccountMeta::new(*signer_pubkey, true));
-        }
-    }
-    let account_data = (ConfigKeys { keys }, data);
-    Instruction::new_with_bincode(ID, &account_data, account_metas)
-}

clients/rust/src/instructions_bincode.rs

@@ -2,7 +2,7 @@
 
 mod generated;
 mod hooked;
-
+#[deprecated(since = "1.0.0", note = "use `solana_config_interface` crate instead")]
 #[cfg(feature = "serde")]
 pub mod instructions_bincode;
 

clients/rust/src/lib.rs

@@ -19,9 +19,6 @@ solana-instruction = { workspace = true, optional = true, features = [
 solana-pubkey = { workspace = true }
 solana-sdk-ids = { workspace = true }
 solana-short-vec = { workspace = true, optional = true }
-solana-stake-interface = { workspace = true, optional = true, features = [
-    "bincode",
-] }
 solana-system-interface = { workspace = true, optional = true, features = [
     "bincode",
 ] }
@@ -31,7 +28,6 @@ bincode = [
     "dep:bincode",
     "dep:solana-account",
     "dep:solana-instruction",
-    "dep:solana-stake-interface",
     "dep:solana-system-interface",
     "serde",
 ]

interface/Cargo.toml

@@ -1,29 +1,29 @@
+//! Program instruction helpers.
+
 use {
-    crate::{
-        id,
-        state::{ConfigKeys, ConfigState},
-    },
+    crate::{id, state::ConfigKeys},
+    bincode::serialized_size,
     solana_instruction::{AccountMeta, Instruction},
     solana_pubkey::Pubkey,
-    solana_system_interface::instruction as system_instruction,
 };
 
-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_with_max_config_space<T: Default + serde::Serialize>(
     from_account_pubkey: &Pubkey,
     config_account_pubkey: &Pubkey,
     lamports: u64,
+    max_config_space: u64,
     keys: Vec<(Pubkey, bool)>,
 ) -> Vec<Instruction> {
-    let space = T::max_space() + bincode::serialized_size(&ConfigKeys { keys }).unwrap();
+    let space = max_config_space.saturating_add(serialized_size(&ConfigKeys { keys }).unwrap());
     vec![
-        system_instruction::create_account(
+        solana_system_interface::instruction::create_account(
             from_account_pubkey,
             config_account_pubkey,
             lamports,
@@ -35,7 +35,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)>,

interface/src/instruction.rs

@@ -1,31 +1,10 @@
 use solana_pubkey::Pubkey;
-#[cfg(feature = "bincode")]
-#[allow(deprecated)]
-use {
-    bincode::{deserialize, serialized_size},
-    solana_stake_interface::config::Config as StakeConfig,
-};
 #[cfg(feature = "serde")]
 use {
     serde_derive::{Deserialize, Serialize},
     solana_short_vec as short_vec,
 };
 
-#[cfg(feature = "serde")]
-pub trait ConfigState: serde::Serialize + Default {
-    /// Maximum space that the serialized representation will require
-    fn max_space() -> u64;
-}
-
-// TODO move ConfigState into `solana_program` to implement trait locally
-#[cfg(feature = "bincode")]
-#[allow(deprecated)]
-impl ConfigState for StakeConfig {
-    fn max_space() -> u64 {
-        serialized_size(&StakeConfig::default()).unwrap()
-    }
-}
-
 /// A collection of keys to be stored in Config account data.
 #[derive(Debug, Default)]
 #[cfg_attr(feature = "serde", derive(Deserialize, Serialize))]
@@ -35,10 +14,3 @@ pub struct ConfigKeys {
     #[cfg_attr(feature = "serde", serde(with = "short_vec"))]
     pub keys: Vec<(Pubkey, bool)>,
 }
-
-#[cfg(feature = "bincode")]
-pub fn get_config_data(bytes: &[u8]) -> Result<&[u8], bincode::Error> {
-    deserialize::<ConfigKeys>(bytes)
-        .and_then(|keys| serialized_size(&keys))
-        .map(|offset| &bytes[offset as usize..])
-}

interface/src/state.rs

@@ -27,7 +27,7 @@ thiserror = { workspace = true }
 [dev-dependencies]
 mollusk-svm = { workspace = true, features = ["fuzz-fd"] }
 mollusk-svm-bencher = { workspace = true }
-solana-config-program-client = { path = "../clients/rust", features = ["serde"] }
+solana-config-interface = { workspace = true, features = ["bincode", "serde"] }
 solana-sdk = { workspace = true }
 
 [lib]

program/Cargo.toml

@@ -1,8 +1,7 @@
 use {
     mollusk_svm_bencher::Bench,
     serde::Serialize,
-    solana_config_program::state::ConfigKeys,
-    solana_config_program_client::instructions_bincode::store,
+    solana_config_interface::{instruction::store, state::ConfigKeys},
     solana_sdk::{
         account::Account,
         hash::Hash,
@@ -27,7 +26,7 @@ impl BenchContext {
 }
 
 /// Trait to avoid re-defining the same instruction and account constructors
-/// for each `ConfigState`.
+/// for each config state.
 pub trait BenchSetup: Default + serde::Serialize {
     const BENCH_ID: &'static str;