Update client to match builtin offchain API (#44)

* client-rust: fix up `fetch` feature

* client-rust: add support for `ConfigKeys` and `get_config_data`

* program: drop `ConfigKeys::serialized_size`

* program: extract the rest of the offchain API

* re-profile compute units

* review feedback

* rename module

* update codama

Author: buffalojoec

Cargo.lock

@@ -28,6 +28,7 @@ mollusk-svm-bencher = "0.0.10-solana-2.0"
 num-derive = "0.4"
 num-traits = "0.2"
 serde = "1.0.193"
+solana-client = "2.0.1"
 solana-program = "2.0.1"
 solana-sdk = "2.0.1"
 thiserror = "1.0.61"

Cargo.toml

@@ -9,14 +9,18 @@ license-file = { workspace = true }
 edition = { workspace = true }
 
 [features]
+fetch = ["dep:solana-client", "dep:solana-sdk"]
+serde = ["dep:bincode", "dep:serde", "kaigan/serde"]
 test-sbf = []
-serde = ["dep:serde"]
 
 [dependencies]
+bincode = { workspace = true, optional = true }
 borsh = { workspace = true }
-kaigan = { workspace = true, features = ["serde"] }
+kaigan = { workspace = true }
 serde = { workspace = true, features = ["derive"], optional = true }
+solana-client = { workspace = true, optional = true }
 solana-program = { workspace = true, features = ["borsh"] }
+solana-sdk = { workspace = true, optional = true }
 
 [dev-dependencies]
 assert_matches = { workspace = true }

clients/rust/Cargo.toml

@@ -42,7 +42,7 @@ impl<'a> TryFrom<&solana_program::account_info::AccountInfo<'a>> for Config {
 #[cfg(feature = "fetch")]
 pub fn fetch_config(
     rpc: &solana_client::rpc_client::RpcClient,
-    address: &Pubkey,
+    address: &solana_program::pubkey::Pubkey,
 ) -> Result<crate::shared::DecodedAccount<Config>, std::io::Error> {
     let accounts = fetch_all_config(rpc, &[*address])?;
     Ok(accounts[0].clone())
@@ -51,10 +51,10 @@ pub fn fetch_config(
 #[cfg(feature = "fetch")]
 pub fn fetch_all_config(
     rpc: &solana_client::rpc_client::RpcClient,
-    addresses: &[Pubkey],
+    addresses: &[solana_program::pubkey::Pubkey],
 ) -> Result<Vec<crate::shared::DecodedAccount<Config>>, std::io::Error> {
     let accounts = rpc
-        .get_multiple_accounts(&addresses)
+        .get_multiple_accounts(addresses)
         .map_err(|e| std::io::Error::new(std::io::ErrorKind::Other, e.to_string()))?;
     let mut decoded_accounts: Vec<crate::shared::DecodedAccount<Config>> = Vec::new();
     for i in 0..addresses.len() {
@@ -76,7 +76,7 @@ pub fn fetch_all_config(
 #[cfg(feature = "fetch")]
 pub fn fetch_maybe_config(
     rpc: &solana_client::rpc_client::RpcClient,
-    address: &Pubkey,
+    address: &solana_program::pubkey::Pubkey,
 ) -> Result<crate::shared::MaybeAccount<Config>, std::io::Error> {
     let accounts = fetch_all_maybe_config(rpc, &[*address])?;
     Ok(accounts[0].clone())
@@ -85,10 +85,10 @@ pub fn fetch_maybe_config(
 #[cfg(feature = "fetch")]
 pub fn fetch_all_maybe_config(
     rpc: &solana_client::rpc_client::RpcClient,
-    addresses: &[Pubkey],
+    addresses: &[solana_program::pubkey::Pubkey],
 ) -> Result<Vec<crate::shared::MaybeAccount<Config>>, std::io::Error> {
     let accounts = rpc
-        .get_multiple_accounts(&addresses)
+        .get_multiple_accounts(addresses)
         .map_err(|e| std::io::Error::new(std::io::ErrorKind::Other, e.to_string()))?;
     let mut decoded_accounts: Vec<crate::shared::MaybeAccount<Config>> = Vec::new();
     for i in 0..addresses.len() {

clients/rust/src/generated/accounts/config.rs

@@ -93,8 +93,21 @@ impl<'de, T: Deserialize<'de>> Deserialize<'de> for ShortVec<T> {
     }
 }
 
-/// ConfigKeys type - uses short vec.
-pub type ConfigKeys = ShortVec<(Pubkey, bool)>;
+#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
+#[derive(BorshDeserialize, BorshSerialize, Clone, Debug, Eq, PartialEq)]
+pub struct ConfigKeys {
+    /// Each key tuple comprises a unique `Pubkey` identifier,
+    /// and `bool` whether that key is a signer of the data.
+    pub keys: ShortVec<(Pubkey, bool)>,
+}
+
+/// Utility for extracting the `ConfigKeys` data from the account data.
+#[cfg(feature = "serde")]
+pub fn get_config_data(bytes: &[u8]) -> Result<&[u8], bincode::Error> {
+    bincode::deserialize::<ConfigKeys>(bytes)
+        .and_then(|keys| bincode::serialized_size(&keys))
+        .map(|offset| &bytes[offset as usize..])
+}
 
 #[cfg(test)]
 mod tests {

clients/rust/src/hooked/short_vec.rs

@@ -1,21 +1,30 @@
 //! Program instruction helpers.
 
 use {
-    crate::{
-        id,
-        state::{ConfigKeys, ConfigState},
-    },
+    crate::{ConfigKeys, ShortVec, ID},
+    bincode::serialized_size,
     solana_program::{
         instruction::{AccountMeta, Instruction},
         pubkey::Pubkey,
         system_instruction,
     },
 };
 
+/// Trait defining config state to be stored at the end of the account data.
+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 {
     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)
+    let account_data = (
+        ConfigKeys {
+            keys: ShortVec(vec![]),
+        },
+        T::default(),
+    );
+    Instruction::new_with_bincode(ID, &account_data, account_metas)
 }
 
 /// Create a new, empty configuration account
@@ -25,14 +34,19 @@ pub fn create_account<T: ConfigState>(
     lamports: u64,
     keys: Vec<(Pubkey, bool)>,
 ) -> Vec<Instruction> {
-    let space = T::max_space().saturating_add(ConfigKeys::serialized_size(keys));
+    let space = T::max_space().saturating_add(
+        serialized_size(&ConfigKeys {
+            keys: ShortVec(keys),
+        })
+        .unwrap(),
+    );
     vec![
         system_instruction::create_account(
             from_account_pubkey,
             config_account_pubkey,
             lamports,
             space,
-            &id(),
+            &ID,
         ),
         initialize_account::<T>(config_account_pubkey),
     ]
@@ -51,6 +65,11 @@ pub fn store<T: ConfigState>(
             account_metas.push(AccountMeta::new(*signer_pubkey, true));
         }
     }
-    let account_data = (ConfigKeys { keys }, data);
-    Instruction::new_with_bincode(id(), &account_data, account_metas)
+    let account_data = (
+        ConfigKeys {
+            keys: ShortVec(keys),
+        },
+        data,
+    );
+    Instruction::new_with_bincode(ID, &account_data, account_metas)
 }

program/src/instruction.rs renamed to clients/rust/src/instructions_bincode.rs

@@ -1,6 +1,11 @@
+#![allow(clippy::arithmetic_side_effects)]
+
 mod generated;
 mod hooked;
 
+#[cfg(feature = "serde")]
+pub mod instructions_bincode;
+
 pub use {
     generated::{programs::SOLANA_CONFIG_ID as ID, *},
     hooked::*,

clients/rust/src/lib.rs

@@ -25,10 +25,10 @@
     "template:upgrade": "zx ./scripts/upgrade-template.mjs"
   },
   "devDependencies": {
-    "@codama/renderers-js": "^1.2.7",
-    "@codama/renderers-rust": "^1.0.16",
+    "@codama/renderers-js": "^1.2.8",
+    "@codama/renderers-rust": "^1.0.17",
     "@iarna/toml": "^2.2.5",
-    "codama": "^1.2.8",
+    "codama": "^1.2.9",
     "typescript": "^5.5.2",
     "zx": "^7.2.3"
   },