Skip to main content

Crate bee_check

Crate bee_check 

Source
Expand description

Core check engine for bee-check.

The CLI in main.rs and (in future) the bee-check-web SPA both consume the same Report shape produced here. See SPEC.md for the JSON shape.

Structs§

ChunkProbe
ChunkVantage
Report
ReseedRequest
StampStatus
Result of the --reseed --stamp <id> pre-flight check. Mirrors ipfs-check’s “stale records” hint in spirit: surface upstream-data problems before doing the operation.
VantageResult

Enums§

OutputFormat
Status
Outcome enum reported per vantage and aggregated for the whole check.

Functions§

check_multi_vantage
Probe /stewardship/{ref} across all vantages in parallel. Alongside the retrievability call, fetches /addresses (overlay) and /health (Bee version) so the rendered report can surface which neighborhood the probe came from. These ancillary calls are best-effort: failure leaves overlay / bee_version unset rather than failing the whole vantage.
check_stamp
Pre-flight check before --reseed: look up GET /stamps/{id} on the target Bee and surface usable/expiry concerns. Mirrors the spirit of ipfs-check’s “stale records” UX hint — flag freshness problems before doing the operation.
drill_down
Walk the manifest at report.reference, probe each leaf chunk via GET /chunks/{addr} from every vantage, and attach the result to the report. When the per-vantage overlay is known (already fetched in check_multi_vantage), each ChunkVantage also carries the proximity between that vantage and the chunk.
render_report
render_stamp_status
Human-readable summary of a stamp pre-flight check, suitable for stderr before a --reseed operation.
reseed