Add serde feature - token-2022 (#3291)

* Add serde to token-2022

* Add tests

* Fix feature syntax

* Formatting, enabling features

* Make CI work, and some naming nit cleanup

* Un-async tests

Co-authored-by: jon wong <[email protected]>
Co-authored-by: Jon Cinque <[email protected]>

Author: 3 people

.github/workflows/pull-request-token.yml

@@ -67,6 +67,14 @@ jobs:
           ./token/twoxtx-setup.sh
           ./ci/cargo-test-bpf.sh token/program-2022-test
 
+      - name: Build and test token-2022 with "serde" activated
+        run: |
+          cargo +"${{ env.RUST_STABLE }}" test \
+            --manifest-path=token/program-2022/Cargo.toml \
+            --features serde-traits \
+            -- --nocapture
+          exit 0
+
       - name: Upload programs
         uses: actions/upload-artifact@v2
         with:

Cargo.lock

@@ -11,6 +11,7 @@ exclude = ["js/**"]
 [features]
 no-entrypoint = []
 test-bpf = []
+serde-traits = ["serde", "serde_with"]
 # Remove these features once the underlying syscalls are released on all networks
 default = ["zk-ops"]
 zk-ops = []
@@ -26,13 +27,16 @@ solana-zk-token-sdk = "1.10.29"
 spl-memo = { version = "3.0.1", path = "../../memo/program", features = [ "no-entrypoint" ] }
 spl-token = { version = "3.3",  path = "../program", features = ["no-entrypoint"] }
 thiserror = "1.0"
+serde = { version = "1.0.136", optional = true }
+serde_with = { version = "1.14.0", optional = true }
 
 [dev-dependencies]
 lazy_static = "1.4.0"
 proptest = "1.0"
 serial_test = "0.5.1"
 solana-program-test = "1.10.29"
 solana-sdk = "1.10.29"
+serde_json = "1.0.81"
 
 [lib]
 crate-type = ["cdylib", "lib"]

token/program-2022/Cargo.toml

@@ -28,6 +28,9 @@ use {
     },
 };
 
+#[cfg(feature = "serde-traits")]
+use serde::{Deserialize, Serialize};
+
 /// Confidential Transfer extension
 pub mod confidential_transfer;
 /// Default Account State extension
@@ -601,6 +604,7 @@ impl Default for AccountType {
 /// applied to mint accounts, and account extensions must only be applied to token holding
 /// accounts.
 #[repr(u16)]
+#[cfg_attr(feature = "serde-traits", derive(Serialize, Deserialize))]
 #[derive(Clone, Copy, Debug, PartialEq, TryFromPrimitive, IntoPrimitive)]
 pub enum ExtensionType {
     /// Used as padding if the account size would otherwise be 355, same as a multisig

token/program-2022/src/extension/mod.rs

@@ -9,7 +9,14 @@ use {
     std::convert::TryFrom,
 };
 
+#[cfg(feature = "serde-traits")]
+use {
+    crate::serialization::coption_fromstr,
+    serde::{Deserialize, Serialize},
+};
+
 /// Transfer Fee extension instructions
+#[cfg_attr(feature = "serde-traits", derive(Serialize, Deserialize))]
 #[derive(Clone, Copy, Debug, PartialEq)]
 #[repr(u8)]
 pub enum TransferFeeInstruction {
@@ -27,8 +34,10 @@ pub enum TransferFeeInstruction {
     ///   0. `[writable]` The mint to initialize.
     InitializeTransferFeeConfig {
         /// Pubkey that may update the fees
+        #[cfg_attr(feature = "serde-traits", serde(with = "coption_fromstr"))]
         transfer_fee_config_authority: COption<Pubkey>,
         /// Withdraw instructions must be signed by this key
+        #[cfg_attr(feature = "serde-traits", serde(with = "coption_fromstr"))]
         withdraw_withheld_authority: COption<Pubkey>,
         /// Amount of transfer collected as fees, expressed as basis points of the
         /// transfer amount

token/program-2022/src/extension/transfer_fee/instruction.rs

@@ -1,5 +1,7 @@
 //! Instruction types
 
+#![allow(deprecated)] // needed to avoid deprecation warning when generating serde implementation for TokenInstruction
+
 use {
     crate::{
         check_program_account, check_spl_token_program_account,
@@ -21,6 +23,13 @@ use {
     },
 };
 
+#[cfg(feature = "serde-traits")]
+use {
+    crate::serialization::coption_fromstr,
+    serde::{Deserialize, Serialize},
+    serde_with::{As, DisplayFromStr},
+};
+
 /// Minimum number of multisignature signers (min N)
 pub const MIN_SIGNERS: usize = 1;
 /// Maximum number of multisignature signers (max N)
@@ -32,6 +41,7 @@ const U64_BYTES: usize = 8;
 
 /// Instructions supported by the token program.
 #[repr(C)]
+#[cfg_attr(feature = "serde-traits", derive(Serialize, Deserialize))]
 #[derive(Clone, Debug, PartialEq)]
 pub enum TokenInstruction<'a> {
     /// Initializes a new mint and optionally deposits all the newly minted
@@ -54,8 +64,10 @@ pub enum TokenInstruction<'a> {
         /// Number of base 10 digits to the right of the decimal place.
         decimals: u8,
         /// The authority/multisignature to mint tokens.
+        #[cfg_attr(feature = "serde-traits", serde(with = "As::<DisplayFromStr>"))]
         mint_authority: Pubkey,
         /// The freeze authority/multisignature of the mint.
+        #[cfg_attr(feature = "serde-traits", serde(with = "coption_fromstr"))]
         freeze_authority: COption<Pubkey>,
     },
     /// Initializes a new account to hold tokens.  If this account is associated
@@ -180,6 +192,7 @@ pub enum TokenInstruction<'a> {
         /// The type of authority to update.
         authority_type: AuthorityType,
         /// The new authority
+        #[cfg_attr(feature = "serde-traits", serde(with = "coption_fromstr"))]
         new_authority: COption<Pubkey>,
     },
     /// Mints new tokens to an account.  The native mint does not support
@@ -444,8 +457,10 @@ pub enum TokenInstruction<'a> {
         /// Number of base 10 digits to the right of the decimal place.
         decimals: u8,
         /// The authority/multisignature to mint tokens.
+        #[cfg_attr(feature = "serde-traits", serde(with = "As::<DisplayFromStr>"))]
         mint_authority: Pubkey,
         /// The freeze authority/multisignature of the mint.
+        #[cfg_attr(feature = "serde-traits", serde(with = "coption_fromstr"))]
         freeze_authority: COption<Pubkey>,
     },
     /// Gets the required size of an account for the given mint as a little-endian
@@ -514,6 +529,7 @@ pub enum TokenInstruction<'a> {
     ///   0. `[writable]` The mint to initialize.
     InitializeMintCloseAuthority {
         /// Authority that must sign the `CloseAccount` instruction on a mint
+        #[cfg_attr(feature = "serde-traits", serde(with = "coption_fromstr"))]
         close_authority: COption<Pubkey>,
     },
     /// The common instruction prefix for Transfer Fee extension instructions.
@@ -933,6 +949,7 @@ impl<'a> TokenInstruction<'a> {
 
 /// Specifies the authority type for SetAuthority instructions
 #[repr(u8)]
+#[cfg_attr(feature = "serde-traits", derive(Serialize, Deserialize))]
 #[derive(Clone, Debug, PartialEq)]
 pub enum AuthorityType {
     /// Authority to mint new tokens

token/program-2022/src/instruction.rs

@@ -10,6 +10,8 @@ pub mod instruction;
 pub mod native_mint;
 pub mod pod;
 pub mod processor;
+#[cfg(feature = "serde-traits")]
+pub mod serialization;
 pub mod state;
 
 #[cfg(not(feature = "no-entrypoint"))]