[token-2022] Add serde support for the rest of token-2022 instructions (

#4772) * token-2022: Add serde support for the rest of token-2022 instructions #3325 * token-2022: Add serde support for the rest of token-2022 instructions #3325 * revert ts file changes * token-2022: Add serde support for the rest of token-2022 instructions #3325 * token-2022: Add serde support for the rest of token-2022 instructions #3325 * token-2022: Add serde support for the rest of token-2022 instructions #3325 * token-2022: Add serde support for the rest of token-2022 instructions #3325 --------- Co-authored-by: un <un@un> Co-authored-by: Serban <@>
solana-labs · Aug 16, 2023 · 46aef02 · 46aef02
1 parent ba40ffb
commit 46aef02
Show file tree

Hide file tree

Showing 14 changed files with 448 additions and 6 deletions.
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/token/program-2022/Cargo.toml b/token/program-2022/Cargo.toml
@@ -11,7 +11,7 @@ exclude = ["js/**"]
 [features]
 no-entrypoint = []
 test-sbf = []
-serde-traits = ["serde", "serde_with"]
+serde-traits = ["serde", "serde_with", "base64"]
 # Remove these features once the underlying syscalls are released on all networks
 default = ["zk-ops"]
 zk-ops = []
@@ -33,6 +33,7 @@ spl-type-length-value = { version = "0.2.0", path = "../../libraries/type-length
 thiserror = "1.0"
 serde = { version = "1.0.183", optional = true }
 serde_with = { version = "3.2.0", optional = true }
+base64 = { version = "0.21.2", optional = true }
 
 [dev-dependencies]
 lazy_static = "1.4.0"

diff --git a/token/program-2022/src/extension/confidential_transfer/instruction.rs b/token/program-2022/src/extension/confidential_transfer/instruction.rs
@@ -20,7 +20,14 @@ use {
     },
 };
 
+#[cfg(feature = "serde-traits")]
+use {
+    crate::serialization::aeciphertext_fromstr,
+    serde::{Deserialize, Serialize},
+};
+
 /// Confidential Transfer extension instructions
+#[cfg_attr(feature = "serde-traits", derive(Serialize, Deserialize))]
 #[derive(Clone, Copy, Debug, TryFromPrimitive, IntoPrimitive)]
 #[repr(u8)]
 pub enum ConfidentialTransferInstruction {
@@ -352,6 +359,7 @@ pub enum ConfidentialTransferInstruction {
 }
 
 /// Data expected by `ConfidentialTransferInstruction::InitializeMint`
+#[cfg_attr(feature = "serde-traits", derive(Serialize, Deserialize))]
 #[derive(Clone, Copy, Debug, PartialEq, Pod, Zeroable)]
 #[repr(C)]
 pub struct InitializeMintData {
@@ -366,6 +374,7 @@ pub struct InitializeMintData {
 }
 
 /// Data expected by `ConfidentialTransferInstruction::UpdateMint`
+#[cfg_attr(feature = "serde-traits", derive(Serialize, Deserialize))]
 #[derive(Clone, Copy, Debug, PartialEq, Pod, Zeroable)]
 #[repr(C)]
 pub struct UpdateMintData {
@@ -377,10 +386,12 @@ pub struct UpdateMintData {
 }
 
 /// Data expected by `ConfidentialTransferInstruction::ConfigureAccount`
+#[cfg_attr(feature = "serde-traits", derive(Serialize, Deserialize))]
 #[derive(Clone, Copy, Debug, PartialEq, Pod, Zeroable)]
 #[repr(C)]
 pub struct ConfigureAccountInstructionData {
     /// The decryptable balance (always 0) once the configure account succeeds
+    #[cfg_attr(feature = "serde-traits", serde(with = "aeciphertext_fromstr"))]
     pub decryptable_zero_balance: DecryptableBalance,
     /// The maximum number of despots and transfers that an account can receiver before the
     /// `ApplyPendingBalance` is executed
@@ -392,6 +403,7 @@ pub struct ConfigureAccountInstructionData {
 }
 
 /// Data expected by `ConfidentialTransferInstruction::EmptyAccount`
+#[cfg_attr(feature = "serde-traits", derive(Serialize, Deserialize))]
 #[derive(Clone, Copy, Debug, PartialEq, Pod, Zeroable)]
 #[repr(C)]
 pub struct EmptyAccountInstructionData {
@@ -402,6 +414,7 @@ pub struct EmptyAccountInstructionData {
 }
 
 /// Data expected by `ConfidentialTransferInstruction::Deposit`
+#[cfg_attr(feature = "serde-traits", derive(Serialize, Deserialize))]
 #[derive(Clone, Copy, Debug, PartialEq, Pod, Zeroable)]
 #[repr(C)]
 pub struct DepositInstructionData {
@@ -412,6 +425,7 @@ pub struct DepositInstructionData {
 }
 
 /// Data expected by `ConfidentialTransferInstruction::Withdraw`
+#[cfg_attr(feature = "serde-traits", derive(Serialize, Deserialize))]
 #[derive(Clone, Copy, Debug, PartialEq, Pod, Zeroable)]
 #[repr(C)]
 pub struct WithdrawInstructionData {
@@ -420,6 +434,7 @@ pub struct WithdrawInstructionData {
     /// Expected number of base 10 digits to the right of the decimal place
     pub decimals: u8,
     /// The new decryptable balance if the withdrawal succeeds
+    #[cfg_attr(feature = "serde-traits", serde(with = "aeciphertext_fromstr"))]
     pub new_decryptable_available_balance: DecryptableBalance,
     /// Relative location of the `ProofInstruction::VerifyWithdraw` instruction to the `Withdraw`
     /// instruction in the transaction. If the offset is `0`, then use a context state account for
@@ -428,10 +443,12 @@ pub struct WithdrawInstructionData {
 }
 
 /// Data expected by `ConfidentialTransferInstruction::Transfer`
+#[cfg_attr(feature = "serde-traits", derive(Serialize, Deserialize))]
 #[derive(Clone, Copy, Debug, PartialEq, Pod, Zeroable)]
 #[repr(C)]
 pub struct TransferInstructionData {
     /// The new source decryptable balance if the transfer succeeds
+    #[cfg_attr(feature = "serde-traits", serde(with = "aeciphertext_fromstr"))]
     pub new_source_decryptable_available_balance: DecryptableBalance,
     /// Relative location of the `ProofInstruction::VerifyTransfer` instruction to the
     /// `Transfer` instruction in the transaction. If the offset is `0`, then use a context state
@@ -440,13 +457,15 @@ pub struct TransferInstructionData {
 }
 
 /// Data expected by `ConfidentialTransferInstruction::ApplyPendingBalance`
+#[cfg_attr(feature = "serde-traits", derive(Serialize, Deserialize))]
 #[derive(Clone, Copy, Debug, PartialEq, Pod, Zeroable)]
 #[repr(C)]
 pub struct ApplyPendingBalanceData {
     /// The expected number of pending balance credits since the last successful
     /// `ApplyPendingBalance` instruction
     pub expected_pending_balance_credit_counter: PodU64,
     /// The new decryptable balance if the pending balance is applied successfully
+    #[cfg_attr(feature = "serde-traits", serde(with = "aeciphertext_fromstr"))]
     pub new_decryptable_available_balance: DecryptableBalance,
 }
 

diff --git a/token/program-2022/src/extension/confidential_transfer_fee/instruction.rs b/token/program-2022/src/extension/confidential_transfer_fee/instruction.rs
@@ -24,7 +24,14 @@ use {
     std::convert::TryFrom,
 };
 
+#[cfg(feature = "serde-traits")]
+use {
+    crate::serialization::{aeciphertext_fromstr, elgamalpubkey_fromstr},
+    serde::{Deserialize, Serialize},
+};
+
 /// Confidential Transfer extension instructions
+#[cfg_attr(feature = "serde-traits", derive(Serialize, Deserialize))]
 #[derive(Clone, Copy, Debug, TryFromPrimitive, IntoPrimitive)]
 #[repr(u8)]
 pub enum ConfidentialTransferFeeInstruction {
@@ -190,17 +197,20 @@ pub enum ConfidentialTransferFeeInstruction {
 }
 
 /// Data expected by `InitializeConfidentialTransferFeeConfig`
+#[cfg_attr(feature = "serde-traits", derive(Serialize, Deserialize))]
 #[derive(Clone, Copy, Debug, PartialEq, Pod, Zeroable)]
 #[repr(C)]
 pub struct InitializeConfidentialTransferFeeConfigData {
     /// confidential transfer fee authority
     pub authority: OptionalNonZeroPubkey,
 
     /// ElGamal public key used to encrypt withheld fees.
+    #[cfg_attr(feature = "serde-traits", serde(with = "elgamalpubkey_fromstr"))]
     pub withdraw_withheld_authority_elgamal_pubkey: ElGamalPubkey,
 }
 
 /// Data expected by `ConfidentialTransferFeeInstruction::WithdrawWithheldTokensFromMint`
+#[cfg_attr(feature = "serde-traits", derive(Serialize, Deserialize))]
 #[derive(Clone, Copy, Debug, PartialEq, Pod, Zeroable)]
 #[repr(C)]
 pub struct WithdrawWithheldTokensFromMintData {
@@ -209,10 +219,12 @@ pub struct WithdrawWithheldTokensFromMintData {
     /// use a context state account for the proof.
     pub proof_instruction_offset: i8,
     /// The new decryptable balance in the destination token account.
+    #[cfg_attr(feature = "serde-traits", serde(with = "aeciphertext_fromstr"))]
     pub new_decryptable_available_balance: DecryptableBalance,
 }
 
 /// Data expected by `ConfidentialTransferFeeInstruction::WithdrawWithheldTokensFromAccounts`
+#[cfg_attr(feature = "serde-traits", derive(Serialize, Deserialize))]
 #[derive(Clone, Copy, Debug, PartialEq, Pod, Zeroable)]
 #[repr(C)]
 pub struct WithdrawWithheldTokensFromAccountsData {
@@ -223,6 +235,7 @@ pub struct WithdrawWithheldTokensFromAccountsData {
     /// `0`, then use a context state account for the proof.
     pub proof_instruction_offset: i8,
     /// The new decryptable balance in the destination token account.
+    #[cfg_attr(feature = "serde-traits", serde(with = "aeciphertext_fromstr"))]
     pub new_decryptable_available_balance: DecryptableBalance,
 }
 

diff --git a/token/program-2022/src/extension/cpi_guard/instruction.rs b/token/program-2022/src/extension/cpi_guard/instruction.rs
@@ -11,7 +11,11 @@ use {
     },
 };
 
+#[cfg(feature = "serde-traits")]
+use serde::{Deserialize, Serialize};
+
 /// CPI Guard extension instructions
+#[cfg_attr(feature = "serde-traits", derive(Serialize, Deserialize))]
 #[derive(Clone, Copy, Debug, PartialEq, IntoPrimitive, TryFromPrimitive)]
 #[repr(u8)]
 pub enum CpiGuardInstruction {

diff --git a/token/program-2022/src/extension/default_account_state/instruction.rs b/token/program-2022/src/extension/default_account_state/instruction.rs
@@ -12,7 +12,11 @@ use {
     std::convert::TryFrom,
 };
 
+#[cfg(feature = "serde-traits")]
+use serde::{Deserialize, Serialize};
+
 /// Default Account State extension instructions
+#[cfg_attr(feature = "serde-traits", derive(Serialize, Deserialize))]
 #[derive(Clone, Copy, Debug, PartialEq, IntoPrimitive, TryFromPrimitive)]
 #[repr(u8)]
 pub enum DefaultAccountStateInstruction {

diff --git a/token/program-2022/src/extension/interest_bearing_mint/instruction.rs b/token/program-2022/src/extension/interest_bearing_mint/instruction.rs
@@ -15,7 +15,11 @@ use {
     std::convert::TryInto,
 };
 
+#[cfg(feature = "serde-traits")]
+use serde::{Deserialize, Serialize};
+
 /// Interesting-bearing mint extension instructions
+#[cfg_attr(feature = "serde-traits", derive(Serialize, Deserialize))]
 #[derive(Clone, Copy, Debug, PartialEq, IntoPrimitive, TryFromPrimitive)]
 #[repr(u8)]
 pub enum InterestBearingMintInstruction {
@@ -57,6 +61,7 @@ pub enum InterestBearingMintInstruction {
 }
 
 /// Data expected by `InterestBearing::Initialize`
+#[cfg_attr(feature = "serde-traits", derive(Serialize, Deserialize))]
 #[derive(Clone, Copy, Pod, Zeroable)]
 #[repr(C)]
 pub struct InitializeInstructionData {

diff --git a/token/program-2022/src/extension/memo_transfer/instruction.rs b/token/program-2022/src/extension/memo_transfer/instruction.rs
@@ -11,7 +11,11 @@ use {
     },
 };
 
+#[cfg(feature = "serde-traits")]
+use serde::{Deserialize, Serialize};
+
 /// Required Memo Transfers extension instructions
+#[cfg_attr(feature = "serde-traits", derive(Serialize, Deserialize))]
 #[derive(Clone, Copy, Debug, PartialEq, IntoPrimitive, TryFromPrimitive)]
 #[repr(u8)]
 pub enum RequiredMemoTransfersInstruction {

diff --git a/token/program-2022/src/extension/metadata_pointer/instruction.rs b/token/program-2022/src/extension/metadata_pointer/instruction.rs
@@ -14,7 +14,11 @@ use {
     std::convert::TryInto,
 };
 
+#[cfg(feature = "serde-traits")]
+use serde::{Deserialize, Serialize};
+
 /// Metadata pointer extension instructions
+#[cfg_attr(feature = "serde-traits", derive(Serialize, Deserialize))]
 #[derive(Clone, Copy, Debug, PartialEq, IntoPrimitive, TryFromPrimitive)]
 #[repr(u8)]
 pub enum MetadataPointerInstruction {
@@ -56,6 +60,7 @@ pub enum MetadataPointerInstruction {
 }
 
 /// Data expected by `Initialize`
+#[cfg_attr(feature = "serde-traits", derive(Serialize, Deserialize))]
 #[derive(Clone, Copy, Pod, Zeroable)]
 #[repr(C)]
 pub struct InitializeInstructionData {
@@ -66,6 +71,7 @@ pub struct InitializeInstructionData {
 }
 
 /// Data expected by `Update`
+#[cfg_attr(feature = "serde-traits", derive(Serialize, Deserialize))]
 #[derive(Clone, Copy, Pod, Zeroable)]
 #[repr(C)]
 pub struct UpdateInstructionData {

diff --git a/token/program-2022/src/extension/transfer_hook/instruction.rs b/token/program-2022/src/extension/transfer_hook/instruction.rs
@@ -14,7 +14,11 @@ use {
     std::convert::TryInto,
 };
 
+#[cfg(feature = "serde-traits")]
+use serde::{Deserialize, Serialize};
+
 /// Transfer hook extension instructions
+#[cfg_attr(feature = "serde-traits", derive(Serialize, Deserialize))]
 #[derive(Clone, Copy, Debug, PartialEq, IntoPrimitive, TryFromPrimitive)]
 #[repr(u8)]
 pub enum TransferHookInstruction {
@@ -56,6 +60,7 @@ pub enum TransferHookInstruction {
 }
 
 /// Data expected by `Initialize`
+#[cfg_attr(feature = "serde-traits", derive(Serialize, Deserialize))]
 #[derive(Clone, Copy, Pod, Zeroable)]
 #[repr(C)]
 pub struct InitializeInstructionData {
@@ -66,6 +71,7 @@ pub struct InitializeInstructionData {
 }
 
 /// Data expected by `Update`
+#[cfg_attr(feature = "serde-traits", derive(Serialize, Deserialize))]
 #[derive(Clone, Copy, Pod, Zeroable)]
 #[repr(C)]
 pub struct UpdateInstructionData {

diff --git a/token/program-2022/src/instruction.rs b/token/program-2022/src/instruction.rs
@@ -420,6 +420,7 @@ pub enum TokenInstruction<'a> {
     ///   2. `[]` Rent sysvar
     InitializeAccount2 {
         /// The new account's owner/multisignature.
+        #[cfg_attr(feature = "serde-traits", serde(with = "As::<DisplayFromStr>"))]
         owner: Pubkey,
     },
     /// Given a wrapped / native token account (a token account containing SOL)
@@ -440,6 +441,7 @@ pub enum TokenInstruction<'a> {
     ///   1. `[]` The mint this account will be associated with.
     InitializeAccount3 {
         /// The new account's owner/multisignature.
+        #[cfg_attr(feature = "serde-traits", serde(with = "As::<DisplayFromStr>"))]
         owner: Pubkey,
     },
     /// Like InitializeMultisig, but does not require the Rent sysvar to be provided
@@ -635,6 +637,7 @@ pub enum TokenInstruction<'a> {
     ///
     InitializePermanentDelegate {
         /// Authority that may sign for `Transfer`s and `Burn`s on any account
+        #[cfg_attr(feature = "serde-traits", serde(with = "As::<DisplayFromStr>"))]
         delegate: Pubkey,
     },
     /// The common instruction prefix for transfer hook extension instructions.