docs: tidy LLM.md indexes; CLAUDE.md -> LLM.md symlink convention

Co-authored-by: Hanzo Dev <[email protected]>
This commit is contained in:
zooqueen
2026-06-17 09:55:44 -07:00
co-authored by Hanzo Dev
parent 2f0af7d7ca
commit d702e5b05e
2 changed files with 72 additions and 72 deletions
-71
View File
@@ -1,71 +0,0 @@
# explorer
**Org:** luxfi · **Ecosystem:** lux · **Path:** `/Users/a/work/lux/luxfi/explorer`
**Origin:** https://github.com/luxfi/explorer.git
## Discovery
This file (`CLAUDE.md`) is the canonical agent-facing readme; `LLM.md` is a symlink to it. Update either name and both stay in sync.
## Where to look first
- `README.md` — human-facing overview (if present)
- `package.json` / `Cargo.toml` / `pyproject.toml` / `go.mod` — language & deps
- `.github/workflows/` — CI surface
- `docs/` — extended docs (if present)
## Sibling repos
See the org-level `LLM.md` at `/Users/a/work/lux/luxfi/LLM.md` for the full inventory of sibling repos and inter-repo dependencies.
## Unified explorer bundle (2026-06-05)
luxfi/explorer + luxfi/graph + luxfi/explore are rolled into ONE Deployment
per env. Architecture:
- **luxfi/explorer (this repo)** — the Go binary `cmd: explorer`. Imports
`github.com/luxfi/indexer` and `github.com/luxfi/graph` as libraries.
Serves on `:8090`:
/v1/indexer/{slug}/* — Blockscout-compatible JSON API
/v1/graph/{slug}/{subgraph}/ — GraphQL per-chain per-subgraph
/v1/explorer/admin/* — Runtime chain registry CRUD
/v1/explorer/realtime — WebSocket + SSE live feed
/ — Embedded SPA shim (fallback only)
Image: `ghcr.io/luxfi/explorer:1.2.18`
- **luxfi/explore** — the Next.js SSR app (Blockscout fork). Serves the
rich SPA at `:3000`. Runs as a **sidecar container in the same Pod**;
shares the network namespace with the explorer Go binary so it can hit
`http://localhost:8090` for data if needed (currently it uses the
public `api-explore.<env>.network` host).
Image: `ghcr.io/luxfi/explore@sha256:ddb15bc28ff38c7619bc08df9337e02b32ef886c33b9993a9b9cb3c475ad75de`
- **luxfi/graph (formerly graphd)** — NOT a separate Deployment. Linked
into the explorer binary as a library. Per-chain GraphQL engines are
spawned by the supervisor when `chains[].graph.enabled: true` in the
chains.yaml ConfigMap.
The legacy `lux-indexer` Deployment (same Go `indexerd` binary, only
indexed EVM) has been **deleted**. Its routes are served by the unified
explorer Deployment.
Per env: 1 Pod, 2 containers, 1 Service exposing `:80 / :8090 / :3000`.
Manifests:
~/work/lux/universe/k8s/lux-mainnet/explorer.yaml
~/work/lux/universe/k8s/lux-mainnet/explore-ingress.yaml
~/work/lux/universe/k8s/lux-testnet/explorer.yaml
~/work/lux/universe/k8s/lux-testnet/explore-ingress.yaml
~/work/lux/universe/k8s/lux-devnet/explorer.yaml
~/work/lux/universe/k8s/lux-devnet/explore-ingress.yaml
Public URLs (all 200 OK, verified 2026-06-05):
https://explore.lux.network (Next.js SPA)
https://api-explore.lux.network/v1/indexer/cchain/blocks
https://api-explore.lux.network/v1/graph/cchain/amm/graphql
https://explore.lux-test.network (Next.js SPA)
https://api-explore.lux-test.network/v1/indexer/cchain/blocks
https://api-explore.lux-test.network/v1/graph/cchain/amm/graphql
https://explore.lux-dev.network (Next.js SPA)
https://api-explore.lux-dev.network/v1/indexer/cchain/blocks
https://api-explore.lux-dev.network/v1/graph/cchain/amm/graphql
Symlink
+1
View File
@@ -0,0 +1 @@
LLM.md
-1
View File
@@ -1 +0,0 @@
CLAUDE.md
+71
View File
@@ -0,0 +1,71 @@
# explorer
**Org:** luxfi · **Ecosystem:** lux · **Path:** `/Users/a/work/lux/luxfi/explorer`
**Origin:** https://github.com/luxfi/explorer.git
## Discovery
This file (`CLAUDE.md`) is the canonical agent-facing readme; `LLM.md` is a symlink to it. Update either name and both stay in sync.
## Where to look first
- `README.md` — human-facing overview (if present)
- `package.json` / `Cargo.toml` / `pyproject.toml` / `go.mod` — language & deps
- `.github/workflows/` — CI surface
- `docs/` — extended docs (if present)
## Sibling repos
See the org-level `LLM.md` at `/Users/a/work/lux/luxfi/LLM.md` for the full inventory of sibling repos and inter-repo dependencies.
## Unified explorer bundle (2026-06-05)
luxfi/explorer + luxfi/graph + luxfi/explore are rolled into ONE Deployment
per env. Architecture:
- **luxfi/explorer (this repo)** — the Go binary `cmd: explorer`. Imports
`github.com/luxfi/indexer` and `github.com/luxfi/graph` as libraries.
Serves on `:8090`:
/v1/indexer/{slug}/* — Blockscout-compatible JSON API
/v1/graph/{slug}/{subgraph}/ — GraphQL per-chain per-subgraph
/v1/explorer/admin/* — Runtime chain registry CRUD
/v1/explorer/realtime — WebSocket + SSE live feed
/ — Embedded SPA shim (fallback only)
Image: `ghcr.io/luxfi/explorer:1.2.18`
- **luxfi/explore** — the Next.js SSR app (Blockscout fork). Serves the
rich SPA at `:3000`. Runs as a **sidecar container in the same Pod**;
shares the network namespace with the explorer Go binary so it can hit
`http://localhost:8090` for data if needed (currently it uses the
public `api-explore.<env>.network` host).
Image: `ghcr.io/luxfi/explore@sha256:ddb15bc28ff38c7619bc08df9337e02b32ef886c33b9993a9b9cb3c475ad75de`
- **luxfi/graph (formerly graphd)** — NOT a separate Deployment. Linked
into the explorer binary as a library. Per-chain GraphQL engines are
spawned by the supervisor when `chains[].graph.enabled: true` in the
chains.yaml ConfigMap.
The legacy `lux-indexer` Deployment (same Go `indexerd` binary, only
indexed EVM) has been **deleted**. Its routes are served by the unified
explorer Deployment.
Per env: 1 Pod, 2 containers, 1 Service exposing `:80 / :8090 / :3000`.
Manifests:
~/work/lux/universe/k8s/lux-mainnet/explorer.yaml
~/work/lux/universe/k8s/lux-mainnet/explore-ingress.yaml
~/work/lux/universe/k8s/lux-testnet/explorer.yaml
~/work/lux/universe/k8s/lux-testnet/explore-ingress.yaml
~/work/lux/universe/k8s/lux-devnet/explorer.yaml
~/work/lux/universe/k8s/lux-devnet/explore-ingress.yaml
Public URLs (all 200 OK, verified 2026-06-05):
https://explore.lux.network (Next.js SPA)
https://api-explore.lux.network/v1/indexer/cchain/blocks
https://api-explore.lux.network/v1/graph/cchain/amm/graphql
https://explore.lux-test.network (Next.js SPA)
https://api-explore.lux-test.network/v1/indexer/cchain/blocks
https://api-explore.lux-test.network/v1/graph/cchain/amm/graphql
https://explore.lux-dev.network (Next.js SPA)
https://api-explore.lux-dev.network/v1/indexer/cchain/blocks
https://api-explore.lux-dev.network/v1/graph/cchain/amm/graphql