Client Development

Overview to Client side development. Quick access to TypeScript and Rust SDKs.

Client Development

Build client applications that interact with ZK Compression across web, Node.js, and native environments using our TypeScript and Rust SDKs.

Core Client SDKs

SDK	Language	Description
@lightprotocol/stateless.js	TypeScript	Core compression SDK with RPC interface, compression/decompression operations, state tree management, and validity proof handling
@lightprotocol/compressed-token	TypeScript	Compressed token operations including mint creation, transfers, SPL compression/decompression, and delegation handling
light-client	Rust	RPC client with Photon indexer API, and local test validator support.

Installation

npm

npm install --save \
    @lightprotocol/stateless.js \
    @lightprotocol/compressed-token \
    @solana/web3.js \
    @lightprotocol/zk-compression-cli

Yarn

yarn add \
    @lightprotocol/stateless.js \
    @lightprotocol/compressed-token \
    @solana/web3.js \
    @lightprotocol/zk-compression-cli

rust-client-sdks.toml

[dependencies]
light-client = "0.13.1" 

Environments

Localnet

Start a local test-validator with the below command. It will start a single-node Solana cluster, an RPC node, and a prover node at ports 8899, 8784, and 3001.

light test-validator 

See the CLI Installation Guide for more.

CLI Installation

Devnet

The Rpc connection is used to interact with the ZK Compression JSON RPC. It's a thin wrapper extending Solana's web3.js Connection class with compression-related endpoints.

Here's how you set up a connection:

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

// Local development
const connection = createRpc(); // Uses local test validator

// DevNet
const connection = createRpc(
  "https://devnet.helius-rpc.com?api-key=YOUR_KEY",
);

// MainNet
const connection = createRpc(
  "https://mainnet.helius-rpc.com?api-key=YOUR_KEY"  
);

Find all ZK Compression related RPC methods below.

JSON RPC methods

Examples

GitHub - Lightprotocol/example-web-clientGitHub

GitHub - Lightprotocol/example-nodejs-clientGitHub

Next Steps

Get an overview of compressed tokens and dive right into the cookbook.

Compressed Tokens