doc: add documentation for all processors

[snawaz]

• No breaking changes
• Standardized documentation for all processors.

[coderabbitai]

Warning

Rate limit exceeded

@snawaz has exceeded the limit for the number of commits that can be reviewed per hour. Please wait 17 minutes and 44 seconds before requesting another review.

Your organization is not enrolled in usage-based pricing. Contact your admin to enable usage-based pricing to continue reviews beyond the rate limit, or try again in 17 minutes and 44 seconds.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

ℹ️ Review info

⚙️ Run configuration

Configuration used: Organization UI

Review profile: ASSERTIVE

Plan: Pro

Run ID: 81f72e18-baa4-4334-96cb-6b6a10ccf075

📥 Commits

Reviewing files that changed from the base of the PR and between 1cfdeda and 6ecb17b.

📒 Files selected for processing (34)

• e-token/src/processor/allocate_transfer_queue.rs
• e-token/src/processor/close_ephemeral_ata.rs
• e-token/src/processor/close_lamports_pda_intent.rs
• e-token/src/processor/close_shuttle_ata_intent.rs
• e-token/src/processor/create_ephemeral_ata_permission.rs
• e-token/src/processor/delegate_ephemeral_ata.rs
• e-token/src/processor/delegate_ephemeral_ata_permission.rs
• e-token/src/processor/delegate_shuttle_ephemeral_ata.rs
• e-token/src/processor/delegate_transfer_queue.rs
• e-token/src/processor/deposit_and_delegate_shuttle_ephemeral_ata_with_merge.rs
• e-token/src/processor/deposit_and_delegate_shuttle_ephemeral_ata_with_merge_and_private_transfer.rs
• e-token/src/processor/deposit_and_queue_transfer.rs
• e-token/src/processor/deposit_spl_tokens.rs
• e-token/src/processor/ensure_transfer_queue_crank.rs
• e-token/src/processor/execute_ready_queued_transfer.rs
• e-token/src/processor/initialize_ephemeral_ata.rs
• e-token/src/processor/initialize_global_vault.rs
• e-token/src/processor/initialize_rent_pda.rs
• e-token/src/processor/initialize_shuttle_ephemeral_ata.rs
• e-token/src/processor/initialize_transfer_queue.rs
• e-token/src/processor/mark_transfer_queue_refill_pending.rs
• e-token/src/processor/merge_shuttle_into_ephemeral_ata.rs
• e-token/src/processor/pending_transfer_queue_refill.rs
• e-token/src/processor/reset_ephemeral_ata_permission.rs
• e-token/src/processor/sponsored_lamports_transfer.rs
• e-token/src/processor/transfer_lamports_pda.rs
• e-token/src/processor/transfer_queue_tick.rs
• e-token/src/processor/undelegate_and_close_shuttle_to_owner.rs
• e-token/src/processor/undelegate_ephemeral_ata.rs
• e-token/src/processor/undelegate_ephemeral_ata_permission.rs
• e-token/src/processor/undelegate_lamports_pda.rs
• e-token/src/processor/undelegation_callback.rs
• e-token/src/processor/withdraw_spl_tokens.rs
• e-token/src/processor/withdraw_through_delegated_shuttle_with_merge.rs

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Commit unit tests in branch snawaz/document

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[snawaz]

• refactor: add debug_log and use it replacing guarded logs #69
• refactor: redesign zero-copy types to make them simpler, faster and less-error prone #67
• feat: add proc macro: fixed_layout  #66
• refactor: heap implemetation #68
• refactor: use requires to assert and automatically log richer information on failure #65
• doc: add documentation for all processors #64 👈 (View in Graphite)
• chore: reorganize the files #63
• audit: review selected process_* #62
• main

This stack of pull requests is managed by Graphite. Learn more about stacking.