Skip to content

Document PacketRouterLivenessReport oracle data type - #2077

Merged
jthiller merged 1 commit into
mainfrom
docs/oracle-liveness-report
Jul 9, 2026
Merged

Document PacketRouterLivenessReport oracle data type#2077
jthiller merged 1 commit into
mainfrom
docs/oracle-liveness-report

Conversation

@jthiller

@jthiller jthiller commented Jul 9, 2026

Copy link
Copy Markdown
Contributor

What

Adds one row to the Oracle Data File Format table in docs/network-data/oracle-data.mdx for the new HPR gateway liveness report.

Field Value
Category foundation-iot-packet-ingest
File Type PacketRouterLivenessReport
File Prefix packet_router_liveness_report
Filename packet_router_liveness_report.<unix_ms_timestamp>.gz
Protobuf service/packet_router.protopacket_router_liveness_report_v1

Why

The helium-packet-router now tracks when each gateway last connected and publishes a daily snapshot to S3, mirroring the existing packet-report pipeline. This is a new decodable data type in the requester-pays bucket, so it belongs in the oracle data reference.

How each field was determined

  • Data type & filenamehelium/helium-packet-router#337 adds hpr_gateway_liveness_reporter, which uploads packet_router_liveness_report.<timestamp>.gz daily.
  • Protobuf linkhelium/proto#481 is merged (commit d79cbd9); packet_router_liveness_report_v1 is at line 8 of packet_router.proto. The link is pinned to that merge commit since the message doesn't exist at the table's older shared commit. (The existing PacketReport row stays pinned to its old commit, where packet_router_packet_report_v1 was still at line 8 — it's now line 14.)
  • S3 category prefix — the ops PRs confirm the glacon-rs-iot-liveness pipeline reads from the helium-mainnet-iot-packet-ingest bucket, the same internal bucket as the existing packetreport files, which surface under foundation-iot-packet-ingest: novalabsxyz/ops-terraform-iot#18, novalabsxyz/ops-terraform-mobile-carrier#139, novalabsxyz/ops-fluxcd#669. Ingester: novalabsxyz/glacon-rs#43.

Reviewer notes

  • Scope is intentionally one table row — the S3 prefix / data-type list lives only in this file, and the type falls under an existing top-level prefix, so no other page (or the top prefix list) needs changing.
  • Prettier passes; diff is a single added line with no table reflow.
  • Heads-up on timing: glacon-rs#43 still points helium-proto at the unmerged macpie/liveness_report branch, and ops-fluxcd#669 notes the image tag needs bumping once a glacon-rs release with this type is cut — so data may not be flowing into the requester-pays bucket yet. The row is accurate for where it will land; happy to mark it forthcoming if preferred.

Add a row to the Oracle Data File Format table for the new HPR gateway
liveness report, which records when each gateway last connected and is
uploaded daily to S3 as packet_router_liveness_report.<ts>.gz.

The file lands under the foundation-iot-packet-ingest prefix (same
internal helium-mainnet-iot-packet-ingest bucket as packetreport) and
decodes with packet_router_liveness_report_v1 in packet_router.proto.

Refs:
- helium/helium-packet-router#337 (produces the report)
- helium/proto#481 (adds packet_router_liveness_report_v1)
- novalabsxyz/glacon-rs#43 (ingests the data type)
@cloudflare-workers-and-pages

Copy link
Copy Markdown

Deploying heliumdocs with  Cloudflare Pages  Cloudflare Pages

Latest commit: a504ce4
Status: ✅  Deploy successful!
Preview URL: https://f4213f5b.heliumdocs.pages.dev
Branch Preview URL: https://docs-oracle-liveness-report.heliumdocs.pages.dev

View logs

@jthiller
jthiller merged commit 40e4bc4 into main Jul 9, 2026
1 check passed
@jthiller
jthiller deleted the docs/oracle-liveness-report branch July 9, 2026 04:19
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.

2 participants