Skip to content

docs(pong): document zero-value contract for Property.ends, Peer.expires, Pong.expires #40

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
VasilevNStas wants to merge 1 commit into
base: master
Choose a base branch
from
Open

docs(pong): document zero-value contract for Property.ends, Peer.expires, Pong.expires #40

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 6 additions & 3 deletions pong.proto
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,8 @@ message Lease {
message Property {
// Unix timestamp (seconds) at which the slot itself expires —
// i.e. when the customer's purchase runs out. Independent of the
// life of the underlying Node (see `expires`).
// life of the underlying Node (see `expires`). Zero means no
// purchase record is available (e.g. not yet loaded from Hub).
uint64 ends = 1;

// ISO 3166-1 alpha-2 country code of the slot ("US", "DE", …).
Expand Down Expand Up @@ -84,7 +85,8 @@ message Peer {
uint64 metered = 4;

// Unix timestamp (seconds) at which the peer is scheduled for
// decommission.
// decommission. Zero means no decommission is scheduled; the
// client MUST NOT treat a zero as "already expired".
uint64 expires = 5;

// TLS Server Name Indication the peer presents on its endpoint.
Expand Down Expand Up @@ -130,7 +132,8 @@ message Pong {
// the authoritative source for the connected Node's retirement;
// when a Property slot is backed by the same Node, the client
// MUST prefer Pong.expires over Property.expires if the two
// disagree.
// disagree. Zero means no decommission is scheduled; the client
// MUST NOT treat a zero as "already expired".
uint64 expires = 14;

// Fixed Unix timestamp (seconds) at which the client's free-tier
Expand Down