Function Difference and Best Practice:
compress(amount, sourceTokenAccount, toAddress)compresses specific amounts from source to a specified recipient. Use for transfers and precise amounts.compressSplTokenAccount(tokenAccount, remainingAmount)compresses the entire SPL token account balance minus optional remaining amount only to the same owner. Use to migrate complete token accounts with optional partial retention. Here is how.
Get Started
1
Compress / Decompress Tokens
Installation
Installation
- npm
- yarn
- pnpm
Install packages in your working directory:Install the CLI globally:
- Localnet
- Devnet
In the code examples, use
createRpc() without arguments for localnet.Before we can compress or decompresss, we need:
- An SPL mint with a token pool for compression. This token pool can be created for new SPL mints via
createMint()or added to existing SPL mints viacreateTokenPool(). - For
compress()SPL tokens in an Associated Token Account, or - For
decompress()compressed token accounts with sufficient balance.
- Compress
- Decompress
Make sure the SPL mint has a token pool for compression.
The script creates this token pool for you.For development, you can create a new mint with token pool via
The script creates this token pool for you.For development, you can create a new mint with token pool via
createMint() or add a token pool to an existing mint via createTokenPool().Troubleshooting
Insufficient balance between decompress and compress
Insufficient balance between decompress and compress
Check your balances before operations:
Invalid owner
Invalid owner
Ensure the signer owns the tokens being decompressed/compressed:
Advanced Configuration
Compress to Different Owner
Compress to Different Owner
Compress tokens directly to someone else:
Batch Operations
Batch Operations
Compress multiple token accounts:
Decompress with Delegate Authority
Decompress with Delegate Authority