doc: add documentation for all processors

Author: snawaz

e-token/src/processor/allocate_transfer_queue.rs

@@ -8,15 +8,21 @@ use crate::assert_owner;
 
 pub const MAX_ITEMS_PER_REALLOC: usize = 10_240 / item_len();
 
+///
+/// Executes on:
+///
+/// Accounts:
+///
+///  0: [writable]          - PDA     : Transfer queue account (PDA derived from [QUEUE_SEED, mint, validator]).
+///  1: []                  - Builtin : System program.
+///
+/// Instruction Data: None
+///
 #[inline(always)]
 pub fn process_allocate_transfer_queue(
     accounts: &[AccountView],
     _instruction_data: &[u8],
 ) -> ProgramResult {
-    // Expected accounts:
-    // 1. [writable] Transfer queue account (PDA derived from [QUEUE_SEED, mint, validator])
-    // 2. []         System program
-
     let [queue_info, _system_program_info, ..] = accounts else {
         return Err(ProgramError::NotEnoughAccountKeys);
     };

e-token/src/processor/close_ephemeral_ata.rs

@@ -3,15 +3,22 @@ use pinocchio::{address::address_eq, error::ProgramError, AccountView, ProgramRe
 
 use crate::{assert_owner, assert_signer};
 
+///
+/// Executes on:
+///
+/// Accounts:
+///
+///  0: [signer]            - Any     : Owner of the ephemeral ATA.
+///  1: [writable]          - PDA     : Ephemeral ATA account (PDA derived from [owner, mint]).
+///  2: [writable]          - Any     : Recipient account for rent refund.
+///
+/// Instruction Data: None
+///
 #[inline(always)]
 pub fn process_close_ephemeral_ata(
     accounts: &[AccountView],
     _instruction_data: &[u8],
 ) -> ProgramResult {
-    // Expected accounts:
-    // 0. [signer]   Owner of the ephemeral ATA
-    // 1. [writable] Ephemeral ATA account (PDA [owner, mint])
-    // 2. [writable] Recipient account for rent refund
     let [owner_info, ephemeral_ata_info, recipient_info, ..] = accounts else {
         return Err(ProgramError::NotEnoughAccountKeys);
     };

e-token/src/processor/close_lamports_pda_intent.rs

@@ -9,6 +9,20 @@ use crate::{
 
 const DLP_EPHEMERAL_BALANCE_TAG: &[u8] = b"balance";
 
+///
+/// Executes on:
+///
+/// Accounts:
+///
+///  0: [writable]          - PDA     : Rent PDA account.
+///  1: [writable]          - PDA     : Lamports PDA account.
+///  2: []                  - Any     : Payer / original authority used in PDA derivation.
+///  3: []                  - Any     : Destination account.
+///  4: []                  - Any     : Escrow authority.
+///  5: [signer]            - PDA     : Escrow signer PDA.
+///
+/// Instruction Data: escrow_index (u8) + salt ([u8; 32])
+///
 #[inline(never)]
 pub fn process_close_lamports_pda_intent(
     accounts: &[AccountView],

e-token/src/processor/close_shuttle_ata_intent.rs

@@ -12,23 +12,26 @@ use pinocchio::{error::ProgramError, AccountView, ProgramResult};
 use pinocchio_token_2022::instructions::CloseAccount;
 const DLP_EPHEMERAL_BALANCE_TAG: &[u8] = b"balance";
 
-/// Post-undelegate handler that first withdraws any remaining shuttle EATA
-/// balance through the shared vault flow, then closes shuttle wallet ATA,
-/// shuttle EATA, and shuttle metadata, refunding rent to the stored payer.
 ///
-/// Expected accounts:
-/// 0. [writable] Shuttle rent reimbursement account (must equal `ShuttleMetadata.payer`)
-/// 1. [writable] Shuttle metadata account
-/// 2. [writable] Shuttle EATA account (PDA [shuttle_metadata, mint])
-/// 3. [writable] Shuttle wallet ATA account
-/// 4. [writable] Destination token account
-/// 5. []         Mint account
-/// 6. []         Global Vault account
-/// 7. [writable] Vault source token account
-/// 8. []         Token program account
-/// 9. []         Source program (must equal this program)
-/// 10. []        Escrow authority
-/// 11. [signer]  Escrow signer PDA
+/// Executes on:
+///
+/// Accounts:
+///
+///  0: [writable]          - Any     : Shuttle rent reimbursement account (must equal `ShuttleMetadata.payer`).
+///  1: [writable]          - PDA     : Shuttle metadata account.
+///  2: [writable]          - PDA     : Shuttle EATA account (PDA derived from [shuttle_metadata, mint]).
+///  3: [writable]          - SPL     : Shuttle wallet ATA account.
+///  4: [writable]          - SPL     : Destination token account.
+///  5: []                  - SPL     : Mint account.
+///  6: []                  - PDA     : Global vault account.
+///  7: [writable]          - SPL     : Vault source token account.
+///  8: []                  - SPL     : Token program account.
+///  9: []                  - Program : Source program (must equal this program).
+/// 10: []                  - Any     : Escrow authority.
+/// 11: [signer]            - PDA     : Escrow signer PDA.
+///
+/// Instruction Data: escrow_index (u8)
+///
 pub fn process_close_shuttle_ata_intent(
     accounts: &[AccountView],
     instruction_data: &[u8],

e-token/src/processor/create_ephemeral_ata_permission.rs

@@ -10,20 +10,24 @@ use pinocchio::{address::address_eq, error::ProgramError, AccountView, ProgramRe
 
 use crate::assert_signer;
 
+///
+/// Executes on:
+///
+/// Accounts:
+///
+///  0: [writable]          - PDA     : Ephemeral ATA account (PDA derived from [owner, mint]).
+///  1: [writable]          - PDA     : Permission PDA (derived from ["permission:", ephemeral_ata]).
+///  2: [signer]            - Keypair : Payer (must match the Ephemeral ATA owner).
+///  3: []                  - Builtin : System program.
+///  4: []                  - Program : Permission program (ACL).
+///
+/// Instruction Data: CreateEphemeralAtaPermission
+///
 #[inline(always)]
 pub fn process_create_ephemeral_ata_permission(
     accounts: &[AccountView],
     instruction_data: &[u8],
 ) -> ProgramResult {
-    // Expected accounts:
-    // 0. [writable] Ephemeral ATA account (PDA derived from [owner, mint]) - signer via seeds
-    // 1. [writable] Permission PDA (derived from ["permission:", ephemeral_ata])
-    // 2. [signer]   Payer (must match Ephemeral ATA owner)
-    // 3. []         System program
-    // 4. []         Permission program (ACL)
-
-    // Instruction data:
-    // [0] MemberFlags bitfield encoded via MemberFlags::to_acl_flag_byte.
     let args = CreateEphemeralAtaPermission::try_from_bytes(instruction_data)?;
 
     let [ephemeral_ata_info, permission_info, payer_info, system_program, permission_program, ..] =

e-token/src/processor/delegate_ephemeral_ata.rs

@@ -3,20 +3,26 @@ use ephemeral_rollups_pinocchio::types::DelegateConfig;
 use ephemeral_spl_api::state::{ephemeral_ata::EphemeralAta, load_initialized};
 use pinocchio::{error::ProgramError, AccountView, Address, ProgramResult};
 
+///
+/// Executes on:
+///
+/// Accounts:
+///
+///  0: [signer]            - Keypair : Payer (seed used to derive the Ephemeral ATA PDA).
+///  1: [writable]          - PDA     : Ephemeral ATA account (PDA derived from [payer, mint]).
+///  2: []                  - Program : Owner program.
+///  3: [writable]          - PDA     : Buffer account.
+///  4: [writable]          - PDA     : Delegation record account.
+///  5: [writable]          - PDA     : Delegation metadata account.
+///  6: []                  - Program : Delegation program.
+///  7: []                  - Builtin : System program.
+///
+/// Instruction Data: DelegateArgs
+///
 pub fn process_delegate_ephemeral_ata(
     accounts: &[AccountView],
     instruction_data: &[u8],
 ) -> ProgramResult {
-    // Expected accounts (in order used below):
-    // 0. [signer]   Payer (seed used to derive Ephemeral ATA PDA)
-    // 1. [writable] Ephemeral ATA account (PDA derived from [payer, mint]) - signer via seeds
-    // 2. []         Owner program (the program owning the delegated PDA)
-    // 3. [writable] Buffer account (used by the delegation program)
-    // 4. [writable] Delegation record account
-    // 5. [writable] Delegation metadata account
-    // 6. []         Delegation program
-    // 7. []         System program
-
     let args = DelegateArgs::try_from_bytes(instruction_data)?;
 
     let [payer_info, ephemeral_ata_info, owner_program, buffer_acc, delegation_record, delegation_metadata, _delegation_program, system_program] =

e-token/src/processor/delegate_ephemeral_ata_permission.rs

@@ -9,23 +9,29 @@ use pinocchio::{
 
 use crate::assert_signer;
 
+///
+/// Executes on:
+///
+/// Accounts:
+///
+///  0: [signer]            - Keypair : Payer (authority).
+///  1: [writable]          - PDA     : Ephemeral ATA account (permissioned account).
+///  2: []                  - Program : Permission program (ACL).
+///  3: [writable]          - PDA     : Permission PDA (derived from ["permission:", ephemeral_ata]).
+///  4: []                  - Builtin : System program.
+///  5: [writable]          - PDA     : Delegation buffer PDA.
+///  6: [writable]          - PDA     : Delegation record PDA.
+///  7: [writable]          - PDA     : Delegation metadata PDA.
+///  8: []                  - Program : Delegation program.
+///  9: []                  - Any     : Validator.
+///
+/// Instruction Data: None
+///
 #[inline(always)]
 pub fn process_delegate_ephemeral_ata_permission(
     accounts: &[AccountView],
     _instruction_data: &[u8],
 ) -> ProgramResult {
-    // Expected accounts:
-    // 0. [signer]   Payer (also authority)
-    // 1. [writable] Ephemeral ATA account (PDA derived from [owner, mint]) - signer via seeds
-    // 2. []         Permission program (ACL)
-    // 3. [writable] Permission PDA (derived from ["permission:", ephemeral_ata])
-    // 4. []         System program
-    // 5. [writable] Delegation buffer PDA (derived from [permission, permission_program])
-    // 6. [writable] Delegation record PDA
-    // 7. [writable] Delegation metadata PDA
-    // 8. []         Delegation program
-    // 9. []         Validator
-
     let [payer_info, ephemeral_ata_info, permission_program, permission_info, system_program, delegation_buffer, delegation_record, delegation_metadata, delegation_program, validator, ..] =
         accounts
     else {

e-token/src/processor/delegate_shuttle_ephemeral_ata.rs

@@ -7,20 +7,27 @@ use pinocchio::{address::address_eq, error::ProgramError, AccountView, Address,
 
 use crate::assert_owner;
 
+///
+/// Executes on:
+///
+/// Accounts:
+///
+///  0: [signer]            - Keypair : Payer.
+///  1: []                  - PDA     : Shuttle metadata account (PDA derived from [owner, mint, shuttle_id]).
+///  2: [writable]          - PDA     : Shuttle EATA account (PDA derived from [shuttle_metadata, mint]).
+///  3: []                  - Program : Owner program.
+///  4: [writable]          - PDA     : Buffer account.
+///  5: [writable]          - PDA     : Delegation record account.
+///  6: [writable]          - PDA     : Delegation metadata account.
+///  7: []                  - Program : Delegation program.
+///  8: []                  - Builtin : System program.
+///
+/// Instruction Data: DelegateShuttleArgs
+///
 pub fn process_delegate_shuttle_ephemeral_ata(
     accounts: &[AccountView],
     instruction_data: &[u8],
 ) -> ProgramResult {
-    // Expected accounts (in order used below):
-    // 0. [signer]   Payer
-    // 1. []         Shuttle metadata account (PDA [owner, mint, shuttle_id])
-    // 2. [writable] Shuttle EATA account (PDA [shuttle_metadata, mint]) - signer via seeds
-    // 3. []         Owner program (the program owning the delegated PDA)
-    // 4. [writable] Buffer account (used by the delegation program)
-    // 5. [writable] Delegation record account
-    // 6. [writable] Delegation metadata account
-    // 7. []         Delegation program
-    // 8. []         System program
     let args = DelegateShuttleArgs::try_from_bytes(instruction_data)?;
 
     let [payer_info, shuttle_info, ephemeral_ata_info, owner_program, buffer_acc, delegation_record, delegation_metadata, _delegation_program, system_program, ..] =

e-token/src/processor/delegate_transfer_queue.rs

@@ -5,20 +5,27 @@ use pinocchio::{address::address_eq, error::ProgramError, AccountView, ProgramRe
 
 use crate::assert_signer;
 
+///
+/// Executes on:
+///
+/// Accounts:
+///
+///  0: [signer]            - Keypair : Payer.
+///  1: [writable]          - PDA     : Transfer queue account (PDA derived from [QUEUE_SEED, mint, validator]).
+///  2: []                  - SPL     : Mint account.
+///  3: []                  - Program : Owner program (this program).
+///  4: [writable]          - PDA     : Buffer account.
+///  5: [writable]          - PDA     : Delegation record account.
+///  6: [writable]          - PDA     : Delegation metadata account.
+///  7: []                  - Program : Delegation program.
+///  8: []                  - Builtin : System program.
+///
+/// Instruction Data: None
+///
 pub fn process_delegate_transfer_queue(
     accounts: &[AccountView],
     instruction_data: &[u8],
 ) -> ProgramResult {
-    // Expected accounts:
-    // 0. [signer]   Payer
-    // 1. [writable] Transfer queue PDA derived from [QUEUE_SEED, mint, validator]
-    // 2. []         Mint account
-    // 3. []         Owner program (this program)
-    // 4. [writable] Buffer account
-    // 5. [writable] Delegation record account
-    // 6. [writable] Delegation metadata account
-    // 7. []         Delegation program
-    // 8. []         System program
     if !instruction_data.is_empty() {
         return Err(ProgramError::InvalidInstructionData);
     }

e-token/src/processor/deposit_and_delegate_shuttle_ephemeral_ata_with_merge.rs

@@ -15,6 +15,33 @@ struct DepositAndDelegateShuttleWithMergeAccounts<'a> {
     pub(crate) destination_token_info: &'a AccountView,
 }
 
+///
+/// Executes on:
+///
+/// Accounts:
+///
+///  0: [signer]            - Keypair : Payer.
+///  1: [writable]          - PDA     : Rent PDA account.
+///  2: [writable]          - PDA     : Shuttle metadata account.
+///  3: [writable]          - PDA     : Shuttle EATA account.
+///  4: [writable]          - SPL     : Shuttle wallet ATA account.
+///  5: [signer]            - Keypair : Shuttle owner.
+///  6: []                  - Program : Owner program.
+///  7: [writable]          - PDA     : Buffer account.
+///  8: [writable]          - PDA     : Delegation record account.
+///  9: [writable]          - PDA     : Delegation metadata account.
+/// 10: []                  - Program : Delegation program.
+/// 11: []                  - SPL     : Associated token program.
+/// 12: []                  - Builtin : System program.
+/// 13: [writable]          - SPL     : Destination token account.
+/// 14: []                  - SPL     : Mint account.
+/// 15: []                  - SPL     : Token program.
+/// 16: []                  - PDA     : Global vault account.
+/// 17: [writable]          - SPL     : Owner source token account.
+/// 18: [writable]          - SPL     : Vault token account.
+///
+/// Instruction Data: DepositAndDelegateShuttleArgs
+///
 #[inline(never)]
 pub fn process_deposit_and_delegate_shuttle_ephemeral_ata_with_merge(
     accounts: &[AccountView],