Intro to Development
Welcome! Light's core primitive is ZK Compression. This guide has everything you need to know to start developing with it.
For the sake of brevity, the guide assumes you are familiar with the basics of Solana. If you aren't, we recommend reading the Solana documentation first.
What you'll need to get started
First things first, you do not need to understand ZK to master ZK Compression!
Development with ZK Compression on Solana consists of two main parts:
client development
on-chain program development
The glue between clients and on-chain programs is the ZK Compression RPC API. It extends Solana's default JSON RPC API with additional endpoints for interacting with ZK compressed state. To view the full list of supported endpoints, visit the JSON RPC Methods section.
Client-side development
You can use SDKs in Rust and Typescript to interact with ZK Compression:
Language | SDK | Description |
---|---|---|
Typescript | SDK to interact with compression programs via the ZK Compression RPC API | |
Typescript | SDK to interact with the compressed token program. | |
Rust | Rust client |
RPC Connection
You'll also need a connection with an RPC to interact with the network. You can either work with an RPC infrastructure provider that supports ZK Compression or run your own RPC Node.
Helius Labs supports ZK Compression and maintains its canonical RPC and Photon indexer implementation here.
Our local dev tooling supports Photon out of the box via the light test-validator
command. To learn how to run a standalone Photon RPC node, visit the Run a Node section.
Quickstart
The code samples work! You can copy & paste them into your IDE or terminal and run!
Installation (node.js, web)
Package Manager | Command |
---|---|
NPM | |
Yarn |
Creating an Rpc connection
Using Localnet
Minting and transferring compressed tokens
This example uses the compressed token program, which is built using ZK Compression and offers an SPL-compatible token layout.
You can find a quickstart guide for creating and transferring compressed-tokens here.
To get started quickly with an end-to-end client for your application, check out the ZK compression web and node examples on GitHub.
On-chain program development
The ZK compression primitive is the core of the Light protocol. To leverage ZK compression, your custom program invokes the Light system program via Cross-Program Invocation (CPI). For the sake of simplicity, we refer to this set of protocol smart contracts as compression programs.
You can write custom programs using ZK compression in Anchor or native Rust.
First, you'll need to ensure your machine has Rust, the Solana CLI, and Anchor installed. If you haven't installed them, refer to this setup guide.
We provide tooling for testing your on-chain program on a local Solana cluster.
ZK Compression CLI: light test-validator
automatically initializes a local Solana cluster with the compression programs, all necessary system accounts, and syscalls activated. By default, it also starts a local Photon RPC instance and Prover node.
Program | Description |
---|---|
The system program. It enforces the compressed account layout with ownership and sum checks and verifies the validity of your input state. Invoke it to create/write to compressed accounts and PDAs. | |
A compressed token implementation built on top of ZK Compression. It enforces a SPL-compatible token layout and allows for arbitrary compression/decompression between this and the SPL standard. | |
Implements state and address trees. Used by the Light System program. |
Build by Example
While you get started building with ZK compression, use these GitHub resources available to help accelerate your journey:
Developer Environments
Today, you can build with ZK compression on Localnet. This is a local Solana cluster that you run on your machine using light test-validator
. A public Devnet will become available soon.
Getting support
For the best support, head to the:
Solana Stackexchange for Solana-specific questions
Light Developer Discord for program-related questions
Helius Developer Discord for RPC-related questions
Remember to include as much detail as possible in your question, and please use text (not screenshots) to show error messages so other people with the same problem can find your question!
Next steps
You're now ready to start building with ZK compression! Head to the Client Quickstart section, or build a program and provide feedback!
Last updated