Skip to content

Commit bd6a651

Browse files
author
tilo-14
committed
fix readme
1 parent 6caa10b commit bd6a651

1 file changed

Lines changed: 41 additions & 24 deletions

File tree

‎README.md‎

Lines changed: 41 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -8,31 +8,48 @@ Light token is a high-performance token standard that reduces the cost of mint a
88

99
## Toolkits
1010

11-
* **[Payments and Wallets](toolkits/payments-and-wallets/)** - All you need for wallet integrations and payment flows. Minimal API differences to SPL.
12-
* **[Streaming Tokens](toolkits/streaming-tokens/)** - Stream mint events using Laserstream
11+
| | Description |
12+
|---------|-------------|
13+
| [Payments and Wallets](toolkits/payments-and-wallets/) | All you need for wallet integrations and payment flows. Minimal API differences to SPL. |
14+
| [Streaming Tokens](toolkits/streaming-tokens/) | Stream mint events using Laserstream |
1315

1416
## Client Examples
1517

16-
| Example | Action | Instruction | Description |
18+
### TypeScript
19+
20+
| | | | Description |
21+
|---------|--------|-------------|-------------|
22+
| create-mint | [Action](typescript-client/actions/create-mint.ts) | [Instruction](typescript-client/instructions/create-mint.ts) | Create a light-token mint with metadata |
23+
| create-ata | [Action](typescript-client/actions/create-ata.ts) | [Instruction](typescript-client/instructions/create-ata.ts) | Create an associated light-token account |
24+
| load-ata | [Action](typescript-client/actions/load-ata.ts) | [Instruction](typescript-client/instructions/load-ata.ts) | Load token accounts from light-token, compressed tokens, SPL/T22 to one unified balance |
25+
| mint-to | [Action](typescript-client/actions/mint-to.ts) | [Instruction](typescript-client/instructions/mint-to.ts) | Mint tokens to a light-account |
26+
| transfer-interface | [Action](typescript-client/actions/transfer-interface.ts) | [Instruction](typescript-client/instructions/transfer-interface.ts) | Transfer between light-token, T22, and SPL accounts |
27+
| wrap | [Action](typescript-client/actions/wrap.ts) | [Instruction](typescript-client/instructions/wrap.ts) | Wrap SPL/T22 to light-token |
28+
| unwrap | [Action](typescript-client/actions/unwrap.ts) | [Instruction](typescript-client/instructions/unwrap.ts) | Unwrap light-token to SPL/T22 |
29+
| delegate-approve | [Action](typescript-client/actions/delegate-approve.ts) | | Approve delegate |
30+
| delegate-revoke | [Action](typescript-client/actions/delegate-revoke.ts) | | Revoke delegate |
31+
32+
### Rust
33+
34+
| | | | Description |
1735
|---------|--------|-------------|-------------|
18-
| **create-mint** | [.ts](typescript-client/actions/create-mint.ts) [.rs](rust-client/actions/create_mint.rs) | [.ts](typescript-client/instructions/create-mint.ts) [.rs](rust-client/instructions/create_mint.rs) | Create a light-token mint with metadata |
19-
| **create-ata** | [.ts](typescript-client/actions/create-ata.ts) [.rs](rust-client/actions/create_ata.rs) | [.ts](typescript-client/instructions/create-ata.ts) [.rs](rust-client/instructions/create_ata.rs) | Create an associated light-token account |
20-
| **create-token-account** | — | [.rs](rust-client/instructions/create_token_account.rs) | Create a light-token account with custom owner |
21-
| **load-ata** | [.ts](typescript-client/actions/load-ata.ts) | [.ts](typescript-client/instructions/load-ata.ts) | Load token accounts from light-token, compressed tokens, SPL/T22 to one unified balance |
22-
| **mint-to** | [.ts](typescript-client/actions/mint-to.ts) [.rs](rust-client/actions/mint_to.rs) | [.ts](typescript-client/instructions/mint-to.ts) [.rs](rust-client/instructions/mint_to.rs) | Mint tokens to a light-account |
23-
| **mint-to-checked** | — | [.rs](rust-client/instructions/mint_to_checked.rs) | Mint tokens with decimal validation |
24-
| **transfer-interface** | [.ts](typescript-client/actions/transfer-interface.ts) [.rs](rust-client/actions/transfer_interface.rs) | [.ts](typescript-client/instructions/transfer-interface.ts) [.rs](rust-client/instructions/transfer_interface.rs) | Transfer between light-token, T22, and SPL accounts |
25-
| **transfer-checked** | [.rs](rust-client/actions/transfer_checked.rs) | [.rs](rust-client/instructions/transfer_checked.rs) | Transfer with decimal validation |
26-
| **spl-to-light-transfer** | — | [.rs](rust-client/instructions/spl_to_light_transfer.rs) | Transfer from SPL to Light via TransferInterface |
27-
| **wrap** | [.ts](typescript-client/actions/wrap.ts) [.rs](rust-client/actions/wrap.rs) | [.ts](typescript-client/instructions/wrap.ts) | Wrap SPL/T22 to light-token |
28-
| **unwrap** | [.ts](typescript-client/actions/unwrap.ts) [.rs](rust-client/actions/unwrap.rs) | [.ts](typescript-client/instructions/unwrap.ts) | Unwrap light-token to SPL/T22 |
29-
| **burn** | — | [.rs](rust-client/instructions/burn.rs) | Burn tokens |
30-
| **burn-checked** | — | [.rs](rust-client/instructions/burn_checked.rs) | Burn tokens with decimal validation |
31-
| **approve** | [.ts](typescript-client/actions/delegate-approve.ts) [.rs](rust-client/actions/approve.rs) | [.rs](rust-client/instructions/approve.rs) | Approve delegate |
32-
| **revoke** | [.ts](typescript-client/actions/delegate-revoke.ts) [.rs](rust-client/actions/revoke.rs) | [.rs](rust-client/instructions/revoke.rs) | Revoke delegate |
33-
| **freeze** | — | [.rs](rust-client/instructions/freeze.rs) | Freeze a token account |
34-
| **thaw** | — | [.rs](rust-client/instructions/thaw.rs) | Thaw a frozen token account |
35-
| **close** | — | [.rs](rust-client/instructions/close.rs) | Close a token account |
36+
| create-mint | [Action](rust-client/actions/create_mint.rs) | [Instruction](rust-client/instructions/create_mint.rs) | Create a light-token mint with metadata |
37+
| create-ata | [Action](rust-client/actions/create_ata.rs) | [Instruction](rust-client/instructions/create_ata.rs) | Create an associated light-token account |
38+
| create-token-account | | [Instruction](rust-client/instructions/create_token_account.rs) | Create a light-token account with custom owner |
39+
| mint-to | [Action](rust-client/actions/mint_to.rs) | [Instruction](rust-client/instructions/mint_to.rs) | Mint tokens to a light-account |
40+
| mint-to-checked | | [Instruction](rust-client/instructions/mint_to_checked.rs) | Mint tokens with decimal validation |
41+
| transfer-interface | [Action](rust-client/actions/transfer_interface.rs) | [Instruction](rust-client/instructions/transfer_interface.rs) | Transfer between light-token, T22, and SPL accounts |
42+
| transfer-checked | [Action](rust-client/actions/transfer_checked.rs) | [Instruction](rust-client/instructions/transfer_checked.rs) | Transfer with decimal validation |
43+
| spl-to-light-transfer | | [Instruction](rust-client/instructions/spl_to_light_transfer.rs) | Transfer from SPL to Light via TransferInterface |
44+
| wrap | [Action](rust-client/actions/wrap.rs) | | Wrap SPL/T22 to light-token |
45+
| unwrap | [Action](rust-client/actions/unwrap.rs) | | Unwrap light-token to SPL/T22 |
46+
| burn | | [Instruction](rust-client/instructions/burn.rs) | Burn tokens |
47+
| burn-checked | | [Instruction](rust-client/instructions/burn_checked.rs) | Burn tokens with decimal validation |
48+
| approve | [Action](rust-client/actions/approve.rs) | [Instruction](rust-client/instructions/approve.rs) | Approve delegate |
49+
| revoke | [Action](rust-client/actions/revoke.rs) | [Instruction](rust-client/instructions/revoke.rs) | Revoke delegate |
50+
| freeze | | [Instruction](rust-client/instructions/freeze.rs) | Freeze a token account |
51+
| thaw | | [Instruction](rust-client/instructions/thaw.rs) | Thaw a frozen token account |
52+
| close | | [Instruction](rust-client/instructions/close.rs) | Close a token account |
3653

3754
## Program Examples
3855

@@ -41,7 +58,7 @@ Light token is a high-performance token standard that reduces the cost of mint a
4158
The instructions use pure CPI calls which you can combine with existing and / or light macros.
4259
For existing programs, you can replace spl_token with light_token instructions as you need. The API is a superset of SPL-token so switching is straightforward.
4360

44-
| Example | Description |
61+
| | Description |
4562
|---------|-------------|
4663
| [approve](programs/anchor/basic-instructions/approve/src/lib.rs) | Approve delegate via CPI |
4764
| [burn](programs/anchor/basic-instructions/burn/src/lib.rs) | Burn tokens via CPI |
@@ -58,7 +75,7 @@ For existing programs, you can replace spl_token with light_token instructions a
5875

5976
### Macros
6077

61-
| Example | Description |
78+
| | Description |
6279
|---------|-------------|
6380
| [counter](programs/anchor/basic-macros/counter) | Create PDA with sponsored rent-exemption |
6481
| [create-associated-token-account](programs/anchor/basic-macros/create-ata) | Create associated light-token account |
@@ -67,7 +84,7 @@ For existing programs, you can replace spl_token with light_token instructions a
6784

6885
### Examples
6986

70-
| Example | Description |
87+
| | Description |
7188
|---------|-------------|
7289
| [create-and-transfer](programs/anchor/create-and-transfer) | Create account via macro and transfer via CPI |
7390

0 commit comments

Comments
 (0)