Skip to content

Commit 1301654

Browse files
author
tilo-14
committed
Improve compressed token documentation structure and content
- Add card-based layout to compressed-token-overview.mdx for use cases - Include cost comparison table showing 50,000x reduction for 100k accounts - Organize advanced guides into Integration and Examples subgroups in docs.json - Convert guide tables from markdown to HTML tables with explicit width styling - Update terminology from 'Regular SPL Token' to 'SPL Token' in overview - Expand expanded property for advanced guide subgroups for better UX
1 parent e7d5a5f commit 1301654

File tree

5 files changed

+165
-49
lines changed

5 files changed

+165
-49
lines changed

‎compressed-token-program/compressed-tokens/compressed-token-overview.mdx‎

Lines changed: 31 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -30,24 +30,41 @@ import InstallDependencies from '/snippets/install-dependencies-codegroup.mdx';
3030
</tbody>
3131
</table>
3232

33-
Compressed token accounts store token balance, owner, and other information like SPL and cTokens.
34-
* Any cToken or SPL token can be compressed/decompressed at will.
35-
36-
* By default, **cTokens** with the **[compressible extension](#compressible) are automatically compressed/decompressed** when inactive/active.
37-
38-
### Recommended usage of compressed token accounts
39-
40-
* For **token distribution** (airdrops, payments, rewards, etc.)
41-
* **Inactive SPL and cToken accounts**.
33+
Compressed token accounts store token balance, owner, and other information like SPL and cTokens. Any cToken or SPL token can be compressed/decompressed at will.
34+
35+
## Recommended Usage of Compressed Tokens
36+
37+
<Card title="">
38+
#### [Token Distribution](#advanced-guides)
39+
* Distribute tokens without paying up front rent per recipient.
40+
* Cost reduction for airdrops, payments, rewards, etc:
41+
<table>
42+
<thead>
43+
<tr>
44+
<th style={{textAlign: 'left'}}></th>
45+
<th style={{textAlign: 'left'}}>SPL Token</th>
46+
<th style={{textAlign: 'left'}}>Compressed Token</th>
47+
</tr>
48+
</thead>
49+
<tbody>
50+
<tr>
51+
<td style={{textAlign: 'left'}}>100,000 Token Accounts</td>
52+
<td style={{textAlign: 'left'}}>~ 200 SOL</td>
53+
<td style={{textAlign: 'left'}}><strong>~ 0.004 SOL</strong></td>
54+
</tr>
55+
</tbody>
56+
</table>
57+
</Card>
58+
<Card title="">
59+
#### Storage of Inactive Token Accounts
4260
* Most (associated) token accounts are not frequently written to.
43-
* Compressing these token accounts allows you to close the account and reclaim rent.
44-
* Migrate to cTokens with compressible extension for automatic compression/decompression when inactive/active.
45-
46-
61+
* **Store token accounts rent-free** when inactive
62+
* Use or migrate to [cTokens with compressible extension](/compressed-token-program/ctoken) for **automatic compression/decompression** when inactive/active.
63+
* The compressible extension allows users to **only pay rent, when token accounts are active**.
64+
</Card>
4765
<Note>
4866
Leading **wallets** like Phantom and Backpack **support compressed tokens**. The UI does not distinguish between SPL and compressed tokens.
4967
</Note>
50-
5168
<Accordion title="Setup">
5269
<Steps>
5370
<Step>

‎compressed-token-program/overview.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ import AdvancedGuidesTable from '/snippets/compressed-tokens-advanced-guides-tab
88
import SetupEnvironment from '/snippets/setup-environment-tabs.mdx';
99
import InstallDependencies from '/snippets/install-dependencies-codegroup.mdx';
1010

11-
| Creation | Regular SPL Token | Compressed Token | Cost Reduction |
11+
| Creation | SPL Token | Compressed Token | Cost Reduction |
1212
|:---------------------|:------------------|:----------------------|:---------------|
1313
| 100 Token Accounts | ~ 0.2 SOL | **~ 0.00004 SOL** | **5000x** |
1414

‎docs.json‎

Lines changed: 38 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -62,13 +62,25 @@
6262
{
6363
"group": "Advanced Guides",
6464
"pages": [
65-
"compressed-token-program/compressed-tokens/advanced-guides/how-to-combine-operations-in-one-transaction",
66-
"compressed-token-program/compressed-tokens/advanced-guides/create-an-airdrop",
67-
"compressed-token-program/compressed-tokens/advanced-guides/create-an-airdrop-with-claim",
68-
"compressed-token-program/compressed-tokens/advanced-guides/add-wallet-support-for-compressed-tokens",
69-
"compressed-token-program/compressed-tokens/advanced-guides/use-token-2022-with-compression",
70-
"compressed-token-program/compressed-tokens/advanced-guides/example-web-client",
71-
"compressed-token-program/compressed-tokens/advanced-guides/example-node-js"
65+
{
66+
"group": "Integration",
67+
"expanded": true,
68+
"pages": [
69+
"compressed-token-program/compressed-tokens/advanced-guides/how-to-combine-operations-in-one-transaction",
70+
"compressed-token-program/compressed-tokens/advanced-guides/add-wallet-support-for-compressed-tokens",
71+
"compressed-token-program/compressed-tokens/advanced-guides/use-token-2022-with-compression"
72+
]
73+
},
74+
{
75+
"group": "Examples",
76+
"expanded": true,
77+
"pages": [
78+
"compressed-token-program/compressed-tokens/advanced-guides/create-an-airdrop",
79+
"compressed-token-program/compressed-tokens/advanced-guides/create-an-airdrop-with-claim",
80+
"compressed-token-program/compressed-tokens/advanced-guides/example-web-client",
81+
"compressed-token-program/compressed-tokens/advanced-guides/example-node-js"
82+
]
83+
}
7284
]
7385
}
7486
]
@@ -196,13 +208,25 @@
196208
{
197209
"group": "Advanced Guides",
198210
"pages": [
199-
"compressed-token-program/compressed-tokens/advanced-guides/how-to-combine-operations-in-one-transaction",
200-
"compressed-token-program/compressed-tokens/advanced-guides/create-an-airdrop",
201-
"compressed-token-program/compressed-tokens/advanced-guides/create-an-airdrop-with-claim",
202-
"compressed-token-program/compressed-tokens/advanced-guides/add-wallet-support-for-compressed-tokens",
203-
"compressed-token-program/compressed-tokens/advanced-guides/use-token-2022-with-compression",
204-
"compressed-token-program/compressed-tokens/advanced-guides/example-web-client",
205-
"compressed-token-program/compressed-tokens/advanced-guides/example-node-js"
211+
{
212+
"group": "Integration",
213+
"expanded": true,
214+
"pages": [
215+
"compressed-token-program/compressed-tokens/advanced-guides/how-to-combine-operations-in-one-transaction",
216+
"compressed-token-program/compressed-tokens/advanced-guides/add-wallet-support-for-compressed-tokens",
217+
"compressed-token-program/compressed-tokens/advanced-guides/use-token-2022-with-compression"
218+
]
219+
},
220+
{
221+
"group": "Examples",
222+
"expanded": true,
223+
"pages": [
224+
"compressed-token-program/compressed-tokens/advanced-guides/create-an-airdrop",
225+
"compressed-token-program/compressed-tokens/advanced-guides/create-an-airdrop-with-claim",
226+
"compressed-token-program/compressed-tokens/advanced-guides/example-web-client",
227+
"compressed-token-program/compressed-tokens/advanced-guides/example-node-js"
228+
]
229+
}
206230
]
207231
}
208232
]

‎snippets/compressed-tokens-advanced-guides-table.mdx‎

Lines changed: 49 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,49 @@
1-
| | |
2-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ |
3-
| [Combine Instructions in One Transaction](/compressed-token-program/compressed-tokens/advanced-guides/how-to-combine-operations-in-one-transaction) | Execute multiple token instructions within a single transaction |
4-
| [Create an Airdrop without Claim](/compressed-token-program/compressed-tokens/advanced-guides/create-an-airdrop) | Create an airdrop that appears directly in recipients' wallets (with or without code) |
5-
| [Example Airdrop with Claim](/compressed-token-program/compressed-tokens/advanced-guides/create-an-airdrop-with-claim) | Demo for time-locked airdrop with compressed tokens |
6-
| [Add Wallet Support for Compressed Tokens](/compressed-token-program/compressed-tokens/advanced-guides/add-wallet-support-for-compressed-tokens) | Add compressed token support in your wallet application |
7-
| [Use Token-2022 with Compression](/compressed-token-program/compressed-tokens/advanced-guides/use-token-2022-with-compression) | Create compressed Token-2022 mints with metadata and other extensions |
8-
| [Example Web Client](/compressed-token-program/compressed-tokens/advanced-guides/example-web-client) | Demonstrates how to use @lightprotocol/stateless.js in a browser environment to interact with ZK Compression |
9-
| [Example Node.js Client](/compressed-token-program/compressed-tokens/advanced-guides/example-node-js) | Script to execute basic compression/decompression/transfers |
1+
<table>
2+
<thead>
3+
<tr>
4+
<th style={{width: '35%', textAlign: 'left'}}></th>
5+
<th style={{width: '65%', textAlign: 'left'}}></th>
6+
</tr>
7+
</thead>
8+
<tbody>
9+
<tr>
10+
<td style={{textAlign: 'left'}}>[Combine Instructions in One Transaction](/compressed-token-program/compressed-tokens/advanced-guides/how-to-combine-operations-in-one-transaction)</td>
11+
<td style={{textAlign: 'left'}}>Execute multiple token instructions within a single transaction</td>
12+
</tr>
13+
<tr>
14+
<td style={{textAlign: 'left'}}>[Add Wallet Support for Compressed Tokens](/compressed-token-program/compressed-tokens/advanced-guides/add-wallet-support-for-compressed-tokens)</td>
15+
<td style={{textAlign: 'left'}}>Add compressed token support in your wallet application</td>
16+
</tr>
17+
<tr>
18+
<td style={{textAlign: 'left'}}>[Use Token-2022 with Compression](/compressed-token-program/compressed-tokens/advanced-guides/use-token-2022-with-compression)</td>
19+
<td style={{textAlign: 'left'}}>Create compressed Token-2022 mints with metadata and other extensions</td>
20+
</tr>
21+
</tbody>
22+
</table>
23+
24+
<table>
25+
<thead>
26+
<tr>
27+
<th style={{width: '35%', textAlign: 'left'}}></th>
28+
<th style={{width: '65%', textAlign: 'left'}}></th>
29+
</tr>
30+
</thead>
31+
<tbody>
32+
<tr>
33+
<td style={{textAlign: 'left'}}>[Create an Airdrop without Claim](/compressed-token-program/compressed-tokens/advanced-guides/create-an-airdrop)</td>
34+
<td style={{textAlign: 'left'}}>Distribute tokens that appear directly in recipients' wallets <br />(via WebApp or CLI)</td>
35+
</tr>
36+
<tr>
37+
<td style={{textAlign: 'left'}}>[Example Airdrop with Claim](/compressed-token-program/compressed-tokens/advanced-guides/create-an-airdrop-with-claim)</td>
38+
<td style={{textAlign: 'left'}}>Demo for time-locked airdrop. Users can claim after vesting.</td>
39+
</tr>
40+
<tr>
41+
<td style={{textAlign: 'left'}}>[Example Web Client](/compressed-token-program/compressed-tokens/advanced-guides/example-web-client)</td>
42+
<td style={{textAlign: 'left'}}>Demo to @lightprotocol/stateless.js in a browser environment</td>
43+
</tr>
44+
<tr>
45+
<td style={{textAlign: 'left'}}>[Example Node.js Client](/compressed-token-program/compressed-tokens/advanced-guides/example-node-js)</td>
46+
<td style={{textAlign: 'left'}}>Script to execute basic compression/decompression/transfers</td>
47+
</tr>
48+
</tbody>
49+
</table>

‎snippets/compressed-tokens-guides-table.mdx‎

Lines changed: 46 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,46 @@
1-
| | |
2-
| :---------------------------------------------------------------------------------------------------------- | :---------------------------------------------------------------------------------------------------- |
3-
| [Create Compressed Token Accounts](/compressed-token-program/compressed-tokens/basic-guides/how-to-create-compressed-token-accounts) | Create compressed and learn difference to regular token accounts |
4-
| [Mint Compressed Tokens](/compressed-token-program/compressed-tokens/basic-guides/how-to-mint-compressed-tokens) | Create new compressed tokens to existing mint |
5-
| [Transfer Compressed Tokens](/compressed-token-program/compressed-tokens/basic-guides/how-to-transfer-compressed-token) | Move compressed tokens between compressed accounts |
6-
| [Decompress and Compress Tokens](/compressed-token-program/compressed-tokens/basic-guides/how-to-compress-and-decompress-spl-tokens) | Convert SPL tokens between regular and compressed format |
7-
| [Compress Complete SPL Token Accounts](/compressed-token-program/compressed-tokens/basic-guides/how-to-compress-complete-spl-token-accounts) | Compress complete SPL token accounts and reclaim rent afterwards |
8-
| [Create and Register a Mint Account for Compression](/compressed-token-program/compressed-tokens/basic-guides/how-to-create-and-register-a-mint-account-for-compression) | Create new SPL mint with token pool for compression |
9-
| [Create Token Pools for Mint Accounts](/compressed-token-program/compressed-tokens/basic-guides/how-to-create-compressed-token-pools-for-mint-accounts) | Create token pool for compression for existing SPL mints |
10-
| [Merge Compressed Accounts](/compressed-token-program/compressed-tokens/basic-guides/how-to-merge-compressed-token-accounts) | Consolidate multiple compressed accounts of the same mint into one |
11-
| [Approve and Revoke Delegate Authority](/compressed-token-program/compressed-tokens/basic-guides/how-to-approve-and-revoke-delegate-authority) | Approve or revoke delegates for compressed token accounts |
1+
<table>
2+
<thead>
3+
<tr>
4+
<th style={{width: '35%', textAlign: 'left'}}></th>
5+
<th style={{width: '65%', textAlign: 'left'}}></th>
6+
</tr>
7+
</thead>
8+
<tbody>
9+
<tr>
10+
<td style={{textAlign: 'left'}}>[Create Compressed Token Accounts](/compressed-token-program/compressed-tokens/basic-guides/how-to-create-compressed-token-accounts)</td>
11+
<td style={{textAlign: 'left'}}>Create compressed and learn difference to regular token accounts</td>
12+
</tr>
13+
<tr>
14+
<td style={{textAlign: 'left'}}>[Mint Compressed Tokens](/compressed-token-program/compressed-tokens/basic-guides/how-to-mint-compressed-tokens)</td>
15+
<td style={{textAlign: 'left'}}>Create new compressed tokens to existing mint</td>
16+
</tr>
17+
<tr>
18+
<td style={{textAlign: 'left'}}>[Transfer Compressed Tokens](/compressed-token-program/compressed-tokens/basic-guides/how-to-transfer-compressed-token)</td>
19+
<td style={{textAlign: 'left'}}>Move compressed tokens between compressed accounts</td>
20+
</tr>
21+
<tr>
22+
<td style={{textAlign: 'left'}}>[Decompress and Compress Tokens](/compressed-token-program/compressed-tokens/basic-guides/how-to-compress-and-decompress-spl-tokens)</td>
23+
<td style={{textAlign: 'left'}}>Convert SPL tokens between regular and compressed format</td>
24+
</tr>
25+
<tr>
26+
<td style={{textAlign: 'left'}}>[Compress Complete SPL Token Accounts](/compressed-token-program/compressed-tokens/basic-guides/how-to-compress-complete-spl-token-accounts)</td>
27+
<td style={{textAlign: 'left'}}>Compress complete SPL token accounts and reclaim rent afterwards</td>
28+
</tr>
29+
<tr>
30+
<td style={{textAlign: 'left'}}>[Create a Mint Account with Token Pool for Compression](/compressed-token-program/compressed-tokens/basic-guides/how-to-create-and-register-a-mint-account-for-compression)</td>
31+
<td style={{textAlign: 'left'}}>Create new SPL mint with token pool for compression</td>
32+
</tr>
33+
<tr>
34+
<td style={{textAlign: 'left'}}>[Create Token Pools for Mint Accounts](/compressed-token-program/compressed-tokens/basic-guides/how-to-create-compressed-token-pools-for-mint-accounts)</td>
35+
<td style={{textAlign: 'left'}}>Create token pool for compression for existing SPL mints</td>
36+
</tr>
37+
<tr>
38+
<td style={{textAlign: 'left'}}>[Merge Compressed Accounts](/compressed-token-program/compressed-tokens/basic-guides/how-to-merge-compressed-token-accounts)</td>
39+
<td style={{textAlign: 'left'}}>Consolidate multiple compressed accounts of the same mint into one</td>
40+
</tr>
41+
<tr>
42+
<td style={{textAlign: 'left'}}>[Approve and Revoke Delegate Authority](/compressed-token-program/compressed-tokens/basic-guides/how-to-approve-and-revoke-delegate-authority)</td>
43+
<td style={{textAlign: 'left'}}>Approve or revoke delegates for compressed token accounts</td>
44+
</tr>
45+
</tbody>
46+
</table>

0 commit comments

Comments
 (0)