add comments

Author: ananas-block

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

@@ -6,6 +6,8 @@ pub mod error;
 
 pub use error::*;
 pub mod state;
+// TODO: cleanup this crate
+// TODO: move all constants to constants.
 
 // Re-export Pubkey type
 #[cfg(feature = "anchor")]

program-libs/ctoken-types/src/state/extensions/compressible.rs

@@ -30,7 +30,7 @@ pub struct CompressibleExtension {
     /// Authority that can close this account (in addition to owner)
     pub rent_authority: Pubkey,
     pub rent_recipient: Pubkey,
-    // TODO: add state variable
+    // TODO: confirm that state variable is not necessary because we realloc memory to 0.
 }
 
 // Implement PdaTimingData trait for integration with light-protocol2's compression SDK
@@ -63,6 +63,7 @@ impl ZCompressibleExtension<'_> {
         Ok(u64::from(target_slot).saturating_sub(current_slot))
     }
 
+    // Note this might clash with rust tests. (Maybe I can use an env variable)
     /// Get the remaining slots until compression is allowed (non-Solana target)
     /// Returns 0 if compression is already allowed
     #[cfg(not(target_os = "solana"))]

programs/compressed-token/program/src/convert_account_infos.rs

@@ -1,6 +1,6 @@
 use anchor_lang::prelude::ProgramError;
 use pinocchio::account_info::AccountInfo;
-
+// TODO: move to light-account-checks
 /// Convert Pinocchio AccountInfo to Solana AccountInfo with minimal safety overhead
 ///
 /// # SAFETY

programs/compressed-token/program/src/decompressed_token_transfer.rs

@@ -23,7 +23,7 @@ pub fn process_decompressed_token_transfer(
         TokenInstruction::Transfer { amount } => {
             let account_infos = unsafe { convert_account_infos::<MAX_ACCOUNTS>(accounts)? };
             // Note:
-            //  need to use light_token_22 fork for token_22 contains
+            //  We need to use light_token_22 fork for token_22 contains
             //  a hardcoded program id check for account ownership.
             light_token_22::processor::Processor::process_transfer(
                 &crate::ID,

programs/compressed-token/program/src/lib.rs

@@ -14,6 +14,7 @@ pub mod extensions;
 pub mod mint_action;
 pub mod shared;
 pub mod transfer2;
+// TODO: move ErrorCode -> pinocchio program and rename to CTokenError
 
 // Reexport the wrapped anchor program.
 pub use ::anchor_compressed_token::*;
@@ -35,12 +36,26 @@ pub const MAX_ACCOUNTS: usize = 30;
 // When adding new instructions check anchor discriminators for collisions!
 #[repr(u8)]
 pub enum InstructionType {
-    DecompressedTransfer = 3, // SPL Token transfer
-    CloseTokenAccount = 9,    // SPL Token CloseAccount
+    /// Decompressed CToken transfer
+    DecompressedTransfer = 3,
+    /// Decompressed CToken CloseAccount
+    CloseTokenAccount = 9,
+    /// Create decompressed CToken, equivalent to SPL Token InitializeAccount3
+    CreateTokenAccount = 18,
+    // TODO: start at 100
     CreateAssociatedTokenAccount = 103,
     Transfer2 = 104,
+    /// Batch instruction for operation on one compressed Mint account:
+    ///     1. CreateMint
+    ///     2. MintTo
+    ///     3. UpdateMintAuthority
+    ///     4. UpdateFreezeAuthority
+    ///     5. CreateSplMint
+    ///     6. MintToDecompressed
+    ///     7. UpdateMetadataField
+    ///     8. UpdateMetadataAuthority
+    ///     9. RemoveMetadataKey
     MintAction = 106,
-    CreateTokenAccount = 18, // equivalen to SPL Token InitializeAccount3
     Other,
 }
 
@@ -49,10 +64,10 @@ impl From<u8> for InstructionType {
         match value {
             3 => InstructionType::DecompressedTransfer,
             9 => InstructionType::CloseTokenAccount,
+            18 => InstructionType::CreateTokenAccount,
             103 => InstructionType::CreateAssociatedTokenAccount,
             104 => InstructionType::Transfer2,
             106 => InstructionType::MintAction,
-            18 => InstructionType::CreateTokenAccount,
             _ => InstructionType::Other,
         }
     }
@@ -101,6 +116,7 @@ pub fn process_instruction(
             process_mint_action(accounts, &instruction_data[1..])?;
         }
         // anchor instructions have no discriminator conflicts with InstructionType
+        // TODO: add test for discriminator conflict
         _ => {
             let account_infos = unsafe { convert_account_infos::<MAX_ACCOUNTS>(accounts)? };
             let account_infos = ManuallyDrop::new(account_infos);

programs/compressed-token/program/src/mint_action/accounts.rs

@@ -306,6 +306,7 @@ pub struct AccountsConfig {
 }
 
 impl AccountsConfig {
+    // TODO: Unit test
     /// Initialize AccountsConfig based in instruction data.  -
     pub fn new(parsed_instruction_data: &ZMintActionCompressedInstructionData) -> AccountsConfig {
         // 1.cpi context