Light Token Cookbook

Recipes


Create Mint	Create light-mints with token metadata
Create ATA	Create associated light-token accounts
Create Token Account	Create light-token accounts
Mint To	Mint tokens to light-token accounts
Close Token Account	Close token account to reclaim remaining lamports
Transfer	Transfer between Light Token, SPL and Token 2022 accounts
Transfer Checked	Transfer between Light Token accounts with decimals verification
Burn	Burn tokens from light-token accounts
Freeze & Thaw	Freeze and thaw light-token accounts
Approve & Revoke	Delegate and revoke token authority
Wrap & Unwrap	Convert between SPL/Token 2022 and light-token
Load ATA	Load cold light-token accounts to hot balance for transfers in one instruction

Setup

TypeScript Client
Rust Client
Program

Dependencies

npm
yarn
pnpm

npm install @lightprotocol/stateless.js@beta \
            @lightprotocol/compressed-token@beta

yarn add @lightprotocol/stateless.js@beta \
         @lightprotocol/compressed-token@beta

pnpm add @lightprotocol/stateless.js@beta \
         @lightprotocol/compressed-token@beta

Developer Environment

Localnet
Devnet

By default, all guides use Localnet.

npm
yarn
pnpm

npm install -g @lightprotocol/zk-compression-cli@beta

yarn global add @lightprotocol/zk-compression-cli@beta

pnpm add -g @lightprotocol/zk-compression-cli@beta

# Start a local test validator
light test-validator

## ensure you have the Solana CLI accessible in your system PATH

// createRpc() defaults to local test validator endpoints
import {
  Rpc,
  createRpc,
} from "@lightprotocol/stateless.js";

const connection: Rpc = createRpc();

async function main() {
  let slot = await connection.getSlot();
  console.log(slot);

  let health = await connection.getIndexerHealth(slot);
  console.log(health);
  // "Ok"
}

main();

Replace <your-api-key> with your actual API key. Get your API key here, if you don’t have one yet.

import { createRpc } from "@lightprotocol/stateless.js";

const RPC_ENDPOINT = "https://devnet.helius-rpc.com?api-key=<your_api_key>";
const connection = createRpc(RPC_ENDPOINT);

async function main() {
  let slot = await connection.getSlot();
  console.log(slot);

  let health = await connection.getIndexerHealth(slot);
  console.log(health);
  // "Ok"
}

main();

Dependencies

Cargo.toml

[dependencies]
light-token = "0.4.0"
light-client = { version = "0.19.0", features = ["v2"] }
solana-sdk = "2"
borsh = "0.10.4"
tokio = { version = "1", features = ["full"] }

Developer Environment

In-Memory (LightProgramTest)
Localnet (LightClient)
Devnet (LightClient)

Test with Lite-SVM (…)

# Initialize project
cargo init my-light-project
cd my-light-project

# Run tests
cargo test

use light_program_test::{LightProgramTest, ProgramTestConfig};
use solana_sdk::signer::Signer;

#[tokio::test]
async fn test_example() {
    // In-memory test environment 
    let mut rpc = LightProgramTest::new(ProgramTestConfig::default())
        .await
        .unwrap();

    let payer = rpc.get_payer().insecure_clone();
    println!("Payer: {}", payer.pubkey());
}

Connects to a local test validator.

npm
yarn
pnpm

npm install -g @lightprotocol/zk-compression-cli@beta

yarn global add @lightprotocol/zk-compression-cli@beta

pnpm add -g @lightprotocol/zk-compression-cli@beta

# Initialize project
cargo init my-light-project
cd my-light-project

# Start local test validator (in separate terminal)
light test-validator

use light_client::rpc::{LightClient, LightClientConfig, Rpc};

#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
    // Connects to http://localhost:8899
    let rpc = LightClient::new(LightClientConfig::local()).await?;

    let slot = rpc.get_slot().await?;
    println!("Current slot: {}", slot);

    Ok(())
}

Replace <your-api-key> with your actual API key. Get your API key here.

use light_client::rpc::{LightClient, LightClientConfig, Rpc};

#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
    let rpc_url = "https://devnet.helius-rpc.com?api-key=<your_api_key>";
    let rpc = LightClient::new(
        LightClientConfig::new(rpc_url.to_string(), None, None)
    ).await?;

    println!("Connected to Devnet");
    Ok(())
}

Dependencies

[dependencies]
light-token = "0.4.0"
light-token-types = "0.4.0"
anchor-lang = "0.31.1"

[dev-dependencies]
light-program-test = { version = "0.19.0", features = ["v2"] }
light-client = { version = "0.19.0", features = ["v2"] }
solana-sdk = "2"
tokio = { version = "1", features = ["full"] }

Developer Environment

In-Memory (LightProgramTest)
Localnet
Devnet

Test with LiteSVM:

# Initialize project
cargo init my-light-project
cd my-light-project

# Build
cargo build-sbf

# Run tests
cargo test-sbf

use light_program_test::{LightProgramTest, ProgramTestConfig};
use solana_sdk::signer::Signer;

#[tokio::test]
async fn test_example() {
    let mut rpc = LightProgramTest::new(ProgramTestConfig::default())
        .await
        .unwrap();

    let payer = rpc.get_payer().insecure_clone();
    println!("Payer: {}", payer.pubkey());
}

npm install -g @lightprotocol/zk-compression-cli@beta

# Start local test validator (in separate terminal)
light test-validator

Replace <your-api-key> with your actual API key. Get your API key here.

use light_client::rpc::{LightClient, LightClientConfig, Rpc};

let rpc_url = "https://devnet.helius-rpc.com?api-key=<your_api_key>";
let rpc = LightClient::new(
    LightClientConfig::new(rpc_url.to_string(), None, None)
).await?;

Get Started

DeFi

Toolkits

Cookbook

Learn

SDK Reference

Recipes

Setup

Get Started

DeFi

Toolkits

Cookbook

Learn

SDK Reference

​Recipes

​Setup

Recipes

Setup