Photon is the core indexer for ZK Compression on the Solana blockchain. It offers rapid indexing capabilities, snapshot support, and flexible database options to cater to local and production deployments.
- Install dependencies:
sudo apt install -y build-essential pkg-config libssl-dev- Install
photon-indexer:
cargo install photon-indexer- Run Photon with default settings against localnet:
photon- Connect to Devnet:
photon --rpc-url=https://api.devnet.solana.com- Use gRPC for block streaming (requires GRPC_X_TOKEN env variable):
photon --rpc-url=https://api.devnet.solana.com --grpc-url=<grpc_url>- Use a local Postgres database:
photon --db-url=postgres://postgres@localhost/postgres- Specify a start slot:
photon --start-slot=123- For more advanced options:
photon --helpPhoton supports snapshots for quick bootstrapping.
- Download a snapshot:
photon-snapshot-loader --snapshot-dir=~/snapshot --snapshot-server-url=https://photon-devnet-snapshot.helius-rpc.com- Run Photon with the snapshot:
photon --snapshot-dir=~/snapshot --rpc-url=https://api.devnet.solana.com --db-url=postgres://postgres@localhost/postgresCreate a local snapshot:
photon-snapshotter --snapshot-dir=~/snapshotStore snapshots in an R2 bucket:
photon-snapshotter --r2-bucket=some-bucket --r2-prefix=prefixNote: Set R2_ACCESS_KEY, R2_ACCOUNT_ID, and R2_SECRET_KEY environment variables when using R2.
Photon supports both Postgres and SQLite. By default, it uses an in-memory SQLite database.
To use a custom database:
export DATABASE_URL="postgres://postgres@localhost/postgres"
photon-migration up
photon --db-url=$DATABASE_URL- Set up the environment:
export MAINNET_RPC_URL=https://api.mainnet-beta.solana.com
export DEVNET_RPC_URL=https://api.devnet.solana.com
export TEST_DATABASE_URL="postgres://postgres@localhost/postgres"- Install additional tools:
npm install -g @apidevtools/swagger-cli
wget https://dl.min.io/server/minio/release/linux-amd64/minio
chmod x minio
docker run -p 3001:3001 docker.io/pmantica1/light-prover:1- Run tests:
cargo testNote: All migrations run automatically during tests for both Postgres and SQLite.
cargo install sea-orm-cli --version 0.10.6
sea-orm-cli generate entity -o src/dao/generatedGenerate OpenAPI schemas:
cargo run --bin=photon-openapiFor support or queries, please open an issue on Github or contact the Helius discord.
