Skip to content

docs: factual README#58

Merged
karelxfi merged 1 commit into
masterfrom
seo/readme
Jun 16, 2026
Merged

docs: factual README#58
karelxfi merged 1 commit into
masterfrom
seo/readme

Conversation

@karelxfi

Copy link
Copy Markdown
Contributor

Expands the README for the SQD Network worker node into a factual, plainly-written document.

What I confirmed (from the actual files)

  • Purpose (Cargo.toml, src/main.rs, src/cli.rs, existing README.md): Rust implementation of the SQD Network worker node. Crate name sqd-worker, version 2.12.0, edition 2021. Downloads its assigned data-lake chunks from persistent storage (S3) and serves queries that reference those chunks. Replaces the previous Python version (subsquid/archive.py).
  • P2P transport (src/main.rs, src/cli.rs): joins the network over a libp2p QUIC transport with a peer ID; mainnet/tethys networks have default boot nodes and assignment URLs filled in automatically.
  • Query engine (Cargo.toml deps: polars, sqd-query, sqd-polars; src/main.rs sets POLARS_MAX_THREADS): queries run against local data using Polars and the SQD query crate.
  • HTTP endpoints (src/http_server.rs): GET /worker/status, GET /worker/peer-id, GET /metrics (OpenMetrics text).
  • CLI options (src/cli.rs): documented --data-dir, --prometheus-port (default 8000), --p2p-port/LISTEN_PORT (default 12345), --public-ip, --parallel-queries (20), --concurrent-downloads (3), --query-threads, --assignment-url.
  • Build (rust-toolchain.toml = Rust 1.89; Dockerfile): cargo build --release produces target/release/sqd-worker; Docker build uses cargo-chef and needs protobuf-compiler, pkg-config, libssl-dev, libsqlite3-dev.
  • License (Cargo.toml, LICENSE.md): AGPL-3.0-or-later.

Style

No marketing language, no em dashes, "onchain" kept as one word (not used in body), no "ship" verb. Only states what the source files show.

Links (all verified 200)

🤖 Generated with Claude Code

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@karelxfi karelxfi merged commit 974ddc7 into master Jun 16, 2026
3 checks passed
@karelxfi karelxfi deleted the seo/readme branch June 16, 2026 16:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant