Are you an LLM? Read llms.txt for a summary of the docs, or llms-full.txt for the full context.
Skip to content

Building & Testing

Prerequisites

  • Rust: toolchain pinned in rust-toolchain.toml (1.97.1, with rustfmt and clippy)
  • git, make, and Python 3.11+ (for CI boundary and test-budget scripts)
  • Network access to fetch the pinned valargroup/wallet-pir and valargroup/ipir-sp git dependencies (use OFFLINE=1 once fetched)

Verify your environment:

make doctor

Building the binaries

Both host binaries select which products to compile via Cargo features. The default build enables no products, and a configuration section for a product not compiled in is rejected at startup.

FeatureConfig sectionNotes
memomemoEpoched tag => memo database
first-contactfirst_contactImplies memo; shares its listener and state_dir
tachygramtachygramEpoched tachygram inclusion/exclusion database
registryregistryOff-chain address registry + PoW write API

Deploy binaries (release, fat LTO)

cargo build --locked --release -p tachyon-pir-publisher --features memo,first-contact,tachygram,registry
cargo build --locked --release -p tachyon-pir-query-server --features memo,first-contact,tachygram,registry
cargo build --locked --release -p tachyon-pir-cli

Fast local iteration (release-fast, no LTO)

cargo build --locked --profile release-fast -p tachyon-pir-publisher --features memo,first-contact,tachygram,registry
cargo build --locked --profile release-fast -p tachyon-pir-query-server --features memo,first-contact,tachygram,registry
cargo build --locked --profile release-fast -p tachyon-pir-cli

Verification gates

CommandWhat it runs
make check-package PACKAGE=<name> [TEST=<filter>]fmt, dependency boundary check, clippy -D warnings, and release-fast tests for one crate
make check-fast BASE=<commit>Same gates for crates changed since BASE and their dependents
make check-correctnessEvery workspace test and doctest under release-fast, timed per test (30 s) and total (300 s)
make check-fullCI tool tests, fmt, boundary check, workspace clippy -D warnings, and workspace tests
make fmtcargo fmt --all

Fast tests run completely offline against synthetic chains and the node double in tools/fixtures. Slow full-geometry and live-testnet tests live behind --features qualification-tests.