extract deserialize-utils crate (solana-labs#3387)

* extract deserialize-utils crate * missing dev dep * rename to solana-serde * fix deprecated since
joncinque · Nov 14, 2024 · 9b29626 · 9b29626
1 parent 0b2b2a3
commit 9b29626
Show file tree

Hide file tree

Showing 7 changed files with 45 additions and 3 deletions.
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/Cargo.toml b/Cargo.toml
@@ -149,6 +149,7 @@ members = [
     "sdk/sdk-ids",
     "sdk/seed-derivable",
     "sdk/seed-phrase",
+    "sdk/serde",
     "sdk/serde-varint",
     "sdk/serialize-utils",
     "sdk/sha256-hasher",
@@ -506,6 +507,7 @@ solana-reward-info = { path = "sdk/reward-info", version = "=2.2.0" }
 solana-sanitize = { path = "sdk/sanitize", version = "=2.2.0" }
 solana-seed-derivable = { path = "sdk/seed-derivable", version = "=2.2.0" }
 solana-seed-phrase = { path = "sdk/seed-phrase", version = "=2.2.0" }
+solana-serde = { path = "sdk/serde", version = "=2.2.0" }
 solana-serde-varint = { path = "sdk/serde-varint", version = "=2.2.0" }
 solana-serialize-utils = { path = "sdk/serialize-utils", version = "=2.2.0" }
 solana-sha256-hasher = { path = "sdk/sha256-hasher", version = "=2.2.0" }

diff --git a/programs/sbf/Cargo.lock b/programs/sbf/Cargo.lock
diff --git a/sdk/Cargo.toml b/sdk/Cargo.toml
@@ -133,6 +133,7 @@ solana-sdk-macro = { workspace = true }
 solana-secp256k1-recover = { workspace = true }
 solana-seed-derivable = { workspace = true, optional = true }
 solana-seed-phrase = { workspace = true, optional = true }
+solana-serde = { workspace = true }
 solana-serde-varint = { workspace = true }
 solana-short-vec = { workspace = true }
 solana-signature = { workspace = true, features = [

diff --git a/sdk/serde/Cargo.toml b/sdk/serde/Cargo.toml
@@ -0,0 +1,20 @@
+[package]
+name = "solana-serde"
+description = "Solana serde helpers"
+documentation = "https://docs.rs/solana-serde"
+version = { workspace = true }
+authors = { workspace = true }
+repository = { workspace = true }
+homepage = { workspace = true }
+license = { workspace = true }
+edition = { workspace = true }
+
+[dependencies]
+serde = { workspace = true }
+
+[dev-dependencies]
+bincode = { workspace = true }
+serde_derive = { workspace = true }
+
+[package.metadata.docs.rs]
+targets = ["x86_64-unknown-linux-gnu"]
diff --git a/sdk/src/deserialize_utils.rs → sdk/serde/src/lib.rs b/sdk/src/deserialize_utils.rs → sdk/serde/src/lib.rs
@@ -33,7 +33,7 @@ pub mod tests {
 
     #[test]
     fn test_default_on_eof() {
-        #[derive(Serialize, Deserialize, Debug, PartialEq, Eq)]
+        #[derive(serde_derive::Serialize, serde_derive::Deserialize, Debug, PartialEq, Eq)]
         struct Foo {
             bar: u16,
             #[serde(deserialize_with = "default_on_eof")]
@@ -108,7 +108,7 @@ pub mod tests {
     fn test_default_on_eof_additional_untagged_fields() {
         // If later fields are not tagged `deserialize_with = "default_on_eof"`, deserialization
         // will panic on any missing fields/data
-        #[derive(Serialize, Deserialize, Debug, PartialEq, Eq)]
+        #[derive(serde_derive::Serialize, serde_derive::Deserialize, Debug, PartialEq, Eq)]
         struct Foo {
             bar: u16,
             #[serde(deserialize_with = "default_on_eof")]

diff --git a/sdk/src/lib.rs b/sdk/src/lib.rs
@@ -63,7 +63,6 @@ pub use solana_program::{borsh, borsh0_10, borsh1};
 pub use solana_signer::signers;
 pub mod client;
 pub mod compute_budget;
-pub mod deserialize_utils;
 pub mod entrypoint;
 pub mod entrypoint_deprecated;
 pub mod epoch_info;
@@ -191,6 +190,8 @@ pub use solana_sdk_macro::declare_id;
 pub use solana_sdk_macro::pubkeys;
 #[deprecated(since = "2.1.0", note = "Use `solana-secp256k1-recover` crate instead")]
 pub use solana_secp256k1_recover as secp256k1_recover;
+#[deprecated(since = "2.2.0", note = "Use `solana-serde` crate instead")]
+pub use solana_serde as deserialize_utils;
 #[deprecated(since = "2.1.0", note = "Use `solana-serde-varint` crate instead")]
 pub use solana_serde_varint as serde_varint;
 #[deprecated(since = "2.1.0", note = "Use `solana-short-vec` crate instead")]