Skip to content

feat: compressed token sdk #1826

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 8 commits into
base: main
Choose a base branch
from

Conversation

ananas-block
Copy link
Contributor

@ananas-block ananas-block commented Jun 17, 2025

See program-tests/sdk-token-test/src/lib.rs for how the compressed-token-sdk currently looks like in a program for compress, transfer and decompress.

For other token program instructions we would add custom CpiInputs and CpiAccounts.
(Maybe that already makes sense for Compress, Decompress, and Transfer, although that might be confusing since you can compress or decompress and transfer in the same cpi to the ctoken program.

TODO:

  1. figure out how to best deal with instruction accounts I would like to find a way without any copies.
    • try to use arrays for instructions with fixed number of accounts
    • bench use of remaining accounts immediately instead of copying (in pinocchio this will be better for sure)
  2. add actions for every instruction in seperate actions crate that depends on light-client

Copy link
Contributor

coderabbitai bot commented Jun 17, 2025

Important

Review skipped

Auto reviews are limited to specific labels.

🏷️ Labels to auto review (1)
  • ai-review

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.


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
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Explain this complex logic.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai explain this code block.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and explain its main purpose.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@ananas-block ananas-block force-pushed the jorrit/feat-compressed-token-sdk branch from 8c97cf0 to 1f49556 Compare June 17, 2025 02:46
Comment on lines 108 to 109
let instruction =
create_compressed_token_instruction(cpi_inputs, &light_cpi_accounts).unwrap();
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

think cleanest to just have dedicated function for each type of cpi instruction (decompress, compress, transfer,..)

example for verbose case:

 let instruction = sdk::decompress_with_amount(
        &mint,        // mint
        claimant.key, // owner
        vec![compressed_token_account],
        proof,
        &light_cpi_accounts,
        None, // amount for partial decompression
        None, // lamport amount
        None, // cpi_context
    )?;

this would then also look very similar to SPL cpis and remove the need for cpiInputs, token_account.decompress(10).unwrap(), and probably even the cTokenAccount abstraction (InputTokenDataWithContext is probably all you need). Another nice effect of this is that it clearly separates all the input_token_account-related info from the action/output. this makes it all semantically intuitive to grok.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this iteration is closer to that.

output_tree_index: u8,
mint: Pubkey,
) -> Result<()> {
let sender_account = light_compressed_token_sdk::account::CTokenAccount::new(
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

add decompress or new_close

@ananas-block ananas-block force-pushed the jorrit/feat-compressed-token-sdk branch from 4d012c3 to 96a5e0e Compare June 24, 2025 15:38
pub cpi_context_pubkey: Option<Pubkey>,
pub cpi_context: Option<CompressedCpiContext>,
pub with_transaction_hash: bool,
pub filter_zero_amount_outputs: bool,
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

todo default should be true

// TODO: test
/// Filter packed accounts for accounts necessary for token accounts.
/// Note accounts still need to be in the correct order.
pub fn filter_packed_accounts<'info>(
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

remove, too expensive


msg!("account metas {:?}", ix.accounts);
msg!("account infos {:?}", account_infos);
panic!("account info and meta don't match.");
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

throw error

mint to spl works

compress works

token transfer works

decompress works

batch compress works

refactor: sdk-token-test ixs into files

with cpi context works

fix: get_validity_proof order

fix: process_update_deposit typo
@ananas-block ananas-block force-pushed the jorrit/feat-compressed-token-sdk branch from 96a5e0e to 3f2b1e8 Compare June 30, 2025 18:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants