Skip to content

Commit af6a4ff

Browse files
author
tilo-14
committed
address comments
1 parent 93abf2f commit af6a4ff

29 files changed

Lines changed: 454 additions & 344 deletions

README.md

Lines changed: 31 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -6,15 +6,25 @@ Light token is a high-performance token standard that reduces the cost of mint a
66
* Light-token accounts can hold balances from any light, SPL, or Token-2022 mint.
77
* Light-mint accounts represent a unique mint and optionally can store token-metadata. Functionally equivalent to SPL mints.
88

9+
## Quick start
10+
11+
```bash
12+
# TypeScript
13+
npx ts-node typescript-client/actions/create-mint.ts
14+
15+
# Rust
16+
cargo run --example action_create_mint
17+
cargo run --example instruction_mint_to_checked
18+
```
19+
920
## Toolkits
1021

1122
* **[Payments and Wallets](toolkits/payments-and-wallets/)** - All you need for wallet integrations and payment flows. Minimal API differences to SPL.
1223
* **[Streaming Tokens](toolkits/streaming-tokens/)** - Stream mint events using Laserstream
1324

1425
## Client
1526

16-
* **spl-to-light-scenario** - Creates SPL mint, mint to SPL ATA, transfer to Light ATA via TransferInterface
17-
* Rust: [Instruction](rust-client/instructions/spl_to_light_transfer.rs)
27+
### Account creation
1828

1929
* **create-mint** - Create a light-token mint
2030
* TypeScript: [Action](typescript-client/actions/create-mint.ts) | [Instruction](typescript-client/instructions/create-mint.ts)
@@ -30,25 +40,28 @@ Light token is a high-performance token standard that reduces the cost of mint a
3040
* **load-ata** - Load token accounts from light-token, compressed tokens, SPL/T22 to one unified balance
3141
* TypeScript: [Action](typescript-client/actions/load-ata.ts) | [Instruction](typescript-client/instructions/load-ata.ts)
3242

43+
### Minting
44+
3345
* **mint-to** - Mint tokens to a light-account
3446
* TypeScript: [Action](typescript-client/actions/mint-to.ts) | [Instruction](typescript-client/instructions/mint-to.ts)
3547
* Rust: [Action](rust-client/actions/mint_to.rs) | [Instruction](rust-client/instructions/mint_to.rs)
3648

3749
* **mint-to-checked** - Mint tokens with decimal validation
3850
* Rust: [Instruction](rust-client/instructions/mint_to_checked.rs)
3951

52+
### Transfers
53+
4054
* **transfer-interface** - Transfer between light-token, T22, and SPL accounts
4155
* TypeScript: [Action](typescript-client/actions/transfer-interface.ts) | [Instruction](typescript-client/instructions/transfer-interface.ts)
4256
* Rust: [Action](rust-client/actions/transfer_interface.rs) | [Instruction](rust-client/instructions/transfer_interface.rs)
4357

4458
* **transfer-checked** - Transfer with decimal validation
4559
* Rust: [Action](rust-client/actions/transfer_checked.rs) | [Instruction](rust-client/instructions/transfer_checked.rs)
4660

47-
* **burn** - Burn tokens
48-
* Rust: [Instruction](rust-client/instructions/burn.rs)
61+
* **spl-to-light-scenario** - Creates SPL mint, mint to SPL ATA, transfer to Light ATA via TransferInterface
62+
* Rust: [Instruction](rust-client/instructions/spl_to_light_transfer.rs)
4963

50-
* **burn-checked** - Burn tokens with decimal validation
51-
* Rust: [Instruction](rust-client/instructions/burn_checked.rs)
64+
### Wrapping
5265

5366
* **wrap** - Wrap SPL/T22 to light-token
5467
* TypeScript: [Action](typescript-client/actions/wrap.ts)
@@ -58,6 +71,16 @@ Light token is a high-performance token standard that reduces the cost of mint a
5871
* TypeScript: [Action](typescript-client/actions/unwrap.ts)
5972
* Rust: [Action](rust-client/actions/unwrap.rs)
6073

74+
### Burning
75+
76+
* **burn** - Burn tokens
77+
* Rust: [Instruction](rust-client/instructions/burn.rs)
78+
79+
* **burn-checked** - Burn tokens with decimal validation
80+
* Rust: [Instruction](rust-client/instructions/burn_checked.rs)
81+
82+
### Delegation
83+
6184
* **approve** - Approve delegate
6285
* TypeScript: [Action](typescript-client/actions/delegate-approve.ts)
6386
* Rust: [Action](rust-client/actions/approve.rs) | [Instruction](rust-client/instructions/approve.rs)
@@ -66,6 +89,8 @@ Light token is a high-performance token standard that reduces the cost of mint a
6689
* TypeScript: [Action](typescript-client/actions/delegate-revoke.ts)
6790
* Rust: [Action](rust-client/actions/revoke.rs) | [Instruction](rust-client/instructions/revoke.rs)
6891

92+
### Account management
93+
6994
* **freeze** - Freeze a token account
7095
* Rust: [Instruction](rust-client/instructions/freeze.rs)
7196

@@ -75,7 +100,6 @@ Light token is a high-performance token standard that reduces the cost of mint a
75100
* **close** - Close a token account
76101
* Rust: [Instruction](rust-client/instructions/close.rs)
77102

78-
79103
## Documentation
80104

81105
Learn more [about Light-Token here](https://www.zkcompression.com/light-token/welcome).

0 commit comments

Comments
 (0)