refactor: ctoken-types remove legacy instruction data, move types to mint_action dir

Author: ananas-block

program-libs/ctoken-types/src/error.rs

@@ -101,6 +101,9 @@ pub enum CTokenError {
 
     #[error("Light compressed account error: {0}")]
     CompressedAccountError(#[from] light_compressed_account::CompressedAccountError),
+
+    #[error("Invalid token metadata version")]
+    InvalidTokenMetadataVersion,
 }
 
 impl From<CTokenError> for u32 {
@@ -136,6 +139,7 @@ impl From<CTokenError> for u32 {
             CTokenError::ZeroCopyExpectedFreezeAuthority => 18027,
             CTokenError::InvalidAuthorityType => 18029,
             CTokenError::ExpectedMintSignerAccount => 18030,
+            CTokenError::InvalidTokenMetadataVersion => 18031,
             CTokenError::HasherError(e) => u32::from(e),
             CTokenError::ZeroCopyError(e) => u32::from(e),
             CTokenError::CompressedAccountError(e) => u32::from(e),

program-libs/ctoken-types/src/instructions/create_spl_mint.rs

@@ -0,0 +1,36 @@
+use light_compressed_account::instruction_data::zero_copy_set::CompressedCpiContextTrait;
+use light_zero_copy::{ZeroCopy, ZeroCopyMut};
+
+use crate::{AnchorDeserialize, AnchorSerialize};
+
+#[repr(C)]
+#[derive(Debug, Clone, AnchorSerialize, AnchorDeserialize, ZeroCopy, ZeroCopyMut)]
+pub struct CpiContext {
+    pub set_context: bool,
+    pub first_set_context: bool,
+    // Used as address tree index if create mint
+    pub in_tree_index: u8,
+    pub in_queue_index: u8,
+    pub out_queue_index: u8,
+    pub token_out_queue_index: u8,
+    // Index of the compressed account that should receive the new address (0 = mint, 1+ = token accounts)
+    pub assigned_account_index: u8,
+}
+
+impl CompressedCpiContextTrait for ZCpiContext<'_> {
+    fn first_set_context(&self) -> u8 {
+        if self.first_set_context == 0 {
+            0
+        } else {
+            1
+        }
+    }
+
+    fn set_context(&self) -> u8 {
+        if self.set_context == 0 {
+            0
+        } else {
+            1
+        }
+    }
+}

program-libs/ctoken-types/src/instructions/extensions/metadata_pointer.rs

@@ -0,0 +1,9 @@
+use light_zero_copy::ZeroCopy;
+
+use crate::{AnchorDeserialize, AnchorSerialize};
+
+#[repr(C)]
+#[derive(Debug, Clone, AnchorSerialize, AnchorDeserialize, ZeroCopy)]
+pub struct CreateSplMintAction {
+    pub mint_bump: u8,
+}

program-libs/ctoken-types/src/instructions/mint_action/cpi_context.rs

@@ -1,11 +1,11 @@
-use light_compressed_account::{
-    instruction_data::{
-        compressed_proof::CompressedProof, zero_copy_set::CompressedCpiContextTrait,
-    },
-    Pubkey,
-};
-use light_zero_copy::{ZeroCopy, ZeroCopyMut};
+use light_compressed_account::{instruction_data::compressed_proof::CompressedProof, Pubkey};
+use light_zero_copy::ZeroCopy;
 
+use super::{
+    CpiContext, CreateSplMintAction, MintToAction, MintToDecompressedAction,
+    RemoveMetadataKeyAction, UpdateAuthority, UpdateMetadataAuthorityAction,
+    UpdateMetadataFieldAction,
+};
 use crate::{
     instructions::extensions::ExtensionInstructionData,
     state::{CompressedMint, ExtensionStruct},
@@ -14,20 +14,48 @@ use crate::{
 
 #[repr(C)]
 #[derive(Debug, Clone, AnchorSerialize, AnchorDeserialize, ZeroCopy)]
-pub struct CreateCompressedMintInstructionData {
-    pub decimals: u8,
-    pub mint_authority: Pubkey,
+pub enum Action {
+    /// Mint compressed tokens to compressed accounts.
+    MintTo(MintToAction),
+    /// Update mint authority of a compressed mint account.
+    UpdateMintAuthority(UpdateAuthority),
+    /// Update freeze authority of a compressed mint account.
+    UpdateFreezeAuthority(UpdateAuthority),
+    /// Create an spl mint for a cmint.
+    /// - existing supply is minted to a token pool account.
+    /// - mint and freeze authority are a ctoken pda.
+    /// - is an spl-token-2022 mint account.
+    CreateSplMint(CreateSplMintAction),
+    /// Mint ctokens from a cmint to a ctoken solana account
+    /// (tokens are not compressed but not spl tokens).
+    MintToDecompressed(MintToDecompressedAction),
+    UpdateMetadataField(UpdateMetadataFieldAction),
+    UpdateMetadataAuthority(UpdateMetadataAuthorityAction),
+    RemoveMetadataKey(RemoveMetadataKeyAction),
+}
+
+#[repr(C)]
+#[derive(Debug, Clone, AnchorSerialize, AnchorDeserialize, ZeroCopy)]
+pub struct MintActionCompressedInstructionData {
+    pub create_mint: bool,
+    /// Only used if create mint
     pub mint_bump: u8,
-    pub address_merkle_tree_root_index: u16,
-    // compressed address TODO: make a type CompressedAddress (not straight forward because of AnchorSerialize)
-    pub mint_address: [u8; 32],
-    pub version: u8,
-    pub freeze_authority: Option<Pubkey>,
-    pub extensions: Option<Vec<ExtensionInstructionData>>,
-    pub cpi_context: Option<CpiContext>,
-    /// To create the compressed mint account address a proof is always required.
-    /// Set none if used with cpi context, the proof is required with the executing cpi.
+    /// Only set if mint already exists
+    pub leaf_index: u32,
+    /// Only set if mint already exists
+    pub prove_by_index: bool,
+    /// If create mint, root index of address proof
+    /// If mint already exists, root index of validity proof
+    /// If proof by index not used.
+    pub root_index: u16,
+    pub compressed_address: [u8; 32],
+    /// If some -> no input because we create mint
+    pub mint: CompressedMintInstructionData,
+    pub token_pool_bump: u8,
+    pub token_pool_index: u8,
+    pub actions: Vec<Action>,
     pub proof: Option<CompressedProof>,
+    pub cpi_context: Option<CpiContext>,
 }
 
 #[repr(C)]
@@ -72,14 +100,6 @@ impl TryFrom<CompressedMint> for CompressedMintInstructionData {
                 let converted_exts: Result<Vec<_>, Self::Error> = exts
                     .into_iter()
                     .map(|ext| match ext {
-                       /* ExtensionStruct::MetadataPointer(metadata_pointer) => {
-                            Ok(ExtensionInstructionData::MetadataPointer(
-                                crate::instructions::extensions::metadata_pointer::InitMetadataPointer {
-                                    authority: metadata_pointer.authority,
-                                    metadata_address: metadata_pointer.metadata_address,
-                                },
-                            ))
-                        }*/
                         ExtensionStruct::TokenMetadata(token_metadata) => {
                             Ok(ExtensionInstructionData::TokenMetadata(
                                 crate::instructions::extensions::token_metadata::TokenMetadataInstructionData {
@@ -112,32 +132,3 @@ impl TryFrom<CompressedMint> for CompressedMintInstructionData {
         })
     }
 }
-#[repr(C)]
-#[derive(
-    Debug, Clone, PartialEq, Eq, AnchorSerialize, AnchorDeserialize, ZeroCopy, ZeroCopyMut,
-)]
-pub struct CpiContext {
-    pub set_context: bool,
-    pub first_set_context: bool,
-    pub address_tree_index: u8,
-    pub out_queue_index: u8,
-    pub cpi_context_pubkey: Pubkey,
-}
-
-impl CompressedCpiContextTrait for ZCpiContext<'_> {
-    fn first_set_context(&self) -> u8 {
-        if self.first_set_context == 0 {
-            0
-        } else {
-            1
-        }
-    }
-
-    fn set_context(&self) -> u8 {
-        if self.set_context == 0 {
-            0
-        } else {
-            1
-        }
-    }
-}

program-libs/ctoken-types/src/instructions/mint_action/create_spl_mint.rs

@@ -0,0 +1,19 @@
+use light_compressed_account::Pubkey;
+use light_zero_copy::ZeroCopy;
+
+use crate::{AnchorDeserialize, AnchorSerialize};
+
+#[repr(C)]
+#[derive(Debug, Clone, AnchorSerialize, AnchorDeserialize, ZeroCopy)]
+pub struct Recipient {
+    pub recipient: Pubkey,
+    pub amount: u64,
+}
+
+#[repr(C)]
+#[derive(Debug, Clone, AnchorSerialize, AnchorDeserialize, ZeroCopy)]
+pub struct MintToAction {
+    pub token_account_version: u8,
+    pub lamports: Option<u64>,
+    pub recipients: Vec<Recipient>,
+}

program-libs/ctoken-types/src/instructions/create_compressed_mint.rs renamed to program-libs/ctoken-types/src/instructions/mint_action/instruction_data.rs

@@ -0,0 +1,16 @@
+use light_zero_copy::ZeroCopy;
+
+use crate::{AnchorDeserialize, AnchorSerialize};
+
+#[repr(C)]
+#[derive(Debug, Clone, AnchorSerialize, AnchorDeserialize, ZeroCopy)]
+pub struct DecompressedRecipient {
+    pub account_index: u8, // Index into remaining accounts for the recipient token account
+    pub amount: u64,
+}
+
+#[repr(C)]
+#[derive(Debug, Clone, AnchorSerialize, AnchorDeserialize, ZeroCopy)]
+pub struct MintToDecompressedAction {
+    pub recipient: DecompressedRecipient,
+}

program-libs/ctoken-types/src/instructions/mint_action/mint_to.rs

@@ -0,0 +1,15 @@
+mod cpi_context;
+mod create_spl_mint;
+mod instruction_data;
+mod mint_to;
+mod mint_to_decompressed;
+mod update_metadata;
+mod update_mint;
+
+pub use cpi_context::*;
+pub use create_spl_mint::*;
+pub use instruction_data::*;
+pub use mint_to::*;
+pub use mint_to_decompressed::*;
+pub use update_metadata::*;
+pub use update_mint::*;