light-compressed-token-sdk 0.23.0

Low-level SDK for compressed token operations on Light Protocol
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70

//! # Light Compressed Token SDK
//!
//! Low-level SDK for compressed token operations on Light Protocol.
//!
//! This crate provides the core building blocks for working with compressed token accounts,
//! including instruction builders for transfers, mints, and compress/decompress operations.
//!
//! ## Compressed Token Accounts
//! - are on Solana mainnet.
//! - are compressed accounts.
//! - can hold Light Mint and SPL Mint tokens.
//! - cost 5,000 lamports to create.
//! - are well suited for airdrops and reward distribution.
//!
//! ## Difference to Light-Token:
//! [light-token](https://github.com/Lightprotocol/light-protocol/tree/main/sdk-libs/token-sdk): Solana account that holds token balances of light-mints, SPL or Token 22 mints for most token use cases (launchpads, DeFi, payments). Mint and token accounts with sponsored rent-exemption.
//! Compressed token: Compressed account storing token data. Rent-free, for storage and distribution. Prefer Light Token for other purposes. Used by Light Token under the hood for rent-free storage of inactive Light Tokens.
//!
//! ## Features
//!
//! - `v1` - Enable v1 compressed token support
//! - `anchor` - Enable Anchor framework integration
//!
//! For full examples, see the [Compressed Token Examples](https://github.com/Lightprotocol/examples-zk-compression).
//!
//! ## Operations reference
//!
//! | Operation | GitHub example |
//! |-----------|----------------|
//! | Create mint | [example](https://github.com/Lightprotocol/examples-zk-compression/blob/main/compressed-token-cookbook/actions/create-mint.ts) |
//! | Mint to | [example](https://github.com/Lightprotocol/examples-zk-compression/blob/main/compressed-token-cookbook/actions/mint-to.ts) |
//! | Transfer | [example](https://github.com/Lightprotocol/examples-zk-compression/blob/main/compressed-token-cookbook/actions/transfer.ts) |
//! | Approve | [example](https://github.com/Lightprotocol/examples-zk-compression/blob/main/compressed-token-cookbook/actions/approve.ts) |
//! | Revoke | [example](https://github.com/Lightprotocol/examples-zk-compression/blob/main/compressed-token-cookbook/actions/revoke.ts) |
//! | Compress | [example](https://github.com/Lightprotocol/examples-zk-compression/blob/main/compressed-token-cookbook/actions/compress.ts) |
//! | Compress SPL account | [example](https://github.com/Lightprotocol/examples-zk-compression/blob/main/compressed-token-cookbook/actions/compress-spl-account.ts) |
//! | Decompress | [example](https://github.com/Lightprotocol/examples-zk-compression/blob/main/compressed-token-cookbook/actions/decompress.ts) |
//! | Merge token accounts | [example](https://github.com/Lightprotocol/examples-zk-compression/blob/main/compressed-token-cookbook/actions/merge-token-accounts.ts) |
//! | Create token pool | [example](https://github.com/Lightprotocol/examples-zk-compression/blob/main/compressed-token-cookbook/actions/create-token-pool.ts) |
//!
//! ### Toolkit guides
//!
//! | Topic | GitHub example |
//! |-------|----------------|
//! | Airdrop | [example](https://github.com/Lightprotocol/examples-zk-compression/tree/main/example-token-distribution) |
//! | Privy integration | [example](https://github.com/Lightprotocol/examples-zk-compression/tree/main/privy) |
//!
//! ## Modules
//!
//! - [`compressed_token`] - Core compressed token types and instruction builders
//! - [`error`] - Error types for compressed token operations
//! - [`utils`] - Utility functions and default account configurations
//! - [`constants`] - Program IDs and other constants
//! - [`spl_interface`] - SPL interface PDA derivation utilities

pub mod compat;
pub mod compressed_token;
pub mod constants;
pub mod error;
pub mod spl_interface;
pub mod utils;

// Conditional anchor re-exports
#[cfg(feature = "anchor")]
use anchor_lang::{AnchorDeserialize, AnchorSerialize};
#[cfg(not(feature = "anchor"))]
use borsh::{BorshDeserialize as AnchorDeserialize, BorshSerialize as AnchorSerialize};
pub use light_compressed_account::instruction_data::compressed_proof::{
    CompressedProof, ValidityProof,
};