Expand description
§truffle-sidecar
Provides the truffle mesh networking sidecar binary.
This crate downloads the platform-specific Go sidecar binary at build time
from truffle’s GitHub releases. At runtime, sidecar_path resolves the
binary location using a smart search order that works in both development
(cargo run) and production (installed binary) scenarios.
§Usage
use truffle_sidecar::sidecar_path;
let path = sidecar_path();
println!("Sidecar at: {}", path.display());§Override
Set TRUFFLE_SIDECAR_PATH environment variable at build time or runtime
to use a custom sidecar binary:
TRUFFLE_SIDECAR_PATH=/usr/local/bin/sidecar-slim cargo buildSet TRUFFLE_SIDECAR_SKIP_DOWNLOAD=1 to skip the build-time download
(useful in CI where the sidecar is provided separately).
Functions§
- sidecar_
path - Returns the path to the truffle sidecar binary.
- version
- Returns the version of the sidecar this crate was built to download.