photon

Photon: der Indexer für ZK-Komprimierung auf Solana

Photon ist der Kernindexer für ZK-Komprimierung auf der Solana-Blockchain. Es bietet schnelle Indizierungsfunktionen, Snapshot-Unterstützung und flexible Datenbankoptionen für lokale und Produktionsbereitstellungen.

Schnellstart

Installation

1. Abhängigkeiten installieren:

sudo apt install -y build-essential pkg-config libssl-dev

2. photon-indexer installieren:

cargo install photon-indexer

? Verwendung

Grundlegende Verwendung

• Führen Sie Photon mit den Standardeinstellungen für localnet aus:

photon

Konfiguration

• Stellen Sie eine Verbindung zu Devnet her:

photon --rpc-url=https://api.devnet.solana.com

• Verwenden Sie gRPC für Block-Streaming (erfordert die Umgebungsvariable GRPC_X_TOKEN):

photon --rpc-url=https://api.devnet.solana.com --grpc-url= < grpc_url >

• Verwenden Sie eine lokale Postgres-Datenbank:

photon --db-url=postgres://postgres@localhost/postgres

• Geben Sie einen Startslot an:

photon --start-slot=123

• Für erweiterte Optionen:

photon --help

? Schnappschüsse

Photon unterstützt Snapshots für schnelles Bootstrapping.

Laden eines Snapshots

1. Laden Sie einen Schnappschuss herunter:

photon-snapshot-loader --snapshot-dir= ~ /snapshot --snapshot-server-url=https://photon-devnet-snapshot.helius-rpc.com

2. Führen Sie Photon mit dem Snapshot aus:

photon --snapshot-dir= ~ /snapshot --rpc-url=https://api.devnet.solana.com --db-url=postgres://postgres@localhost/postgres

Schnappschüsse erstellen

Erstellen Sie einen lokalen Snapshot:

photon-snapshotter --snapshot-dir= ~ /snapshot

Speichern Sie Snapshots in einem R2-Bucket:

photon-snapshotter --r2-bucket=some-bucket --r2-prefix=prefix

Hinweis: Legen Sie die Umgebungsvariablen R2_ACCESS_KEY , R2_ACCOUNT_ID und R2_SECRET_KEY fest, wenn Sie R2 verwenden.

?️ Datenbankverwaltung

Photon unterstützt sowohl Postgres als auch SQLite. Standardmäßig wird eine In-Memory-SQLite-Datenbank verwendet.

So verwenden Sie eine benutzerdefinierte Datenbank:

 export DATABASE_URL= " postgres://postgres@localhost/postgres "
photon-migration up
photon --db-url= $DATABASE_URL 

Lokale Entwicklung

Ausführen von Tests

1. Richten Sie die Umgebung ein:

 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 "

2. Installieren Sie zusätzliche 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

3. Führen Sie Tests durch:

cargo test

Hinweis: Alle Migrationen werden während der Tests sowohl für Postgres als auch für SQLite automatisch ausgeführt.

Generierung von Datenbankmodellen

cargo install sea-orm-cli --version 0.10.6
sea-orm-cli generate entity -o src/dao/generated

API-Dokumentation

Generieren Sie OpenAPI-Schemas:

cargo run --bin=photon-openapi

? Unterstützung

Für Unterstützung oder Fragen öffnen Sie bitte ein Problem auf Github oder wenden Sie sich an den Helius-Discord.