Skip to content
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

Jump to bottom

Document suggested IPNS Entry TTL default #371

Merged
merged 2 commits into from
Oct 3, 2023
Merged

Document suggested IPNS Entry TTL default #371

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
942569e
docs: add suggested default 12h for IPNS Entry TTL
hacdias Jan 25, 2023
f68df0c
ipns-record: fix lint, add context for ttl
lidel Oct 3, 2023
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
5 changes: 3 additions & 2 deletions src/ipns/ipns-record.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: IPNS Record and Protocol
description: >
Specifies the IPNS protocol in a language-agnostic manner, allowing everyone to
create a compatible IPNS Record Publisher or Resolver.
date: 2023-07-24
date: 2023-10-03
maturity: reliable
editors:
- name: Vasco Santos
Expand Down Expand Up @@ -151,8 +151,9 @@ A logical :dfn[IPNS Record] is a data structure containing the following fields:
- Implementations MUST include this value in inside the DAG-CBOR document at `IpnsEntry.data[Sequence]`.

- **TTL** (uint64)
- A hint for how long the record should be cached before going back to, for instance the DHT, in order to check if it has been updated.
- A hint for how long (in nanoseconds) the record should be cached before going back to, for instance the DHT, in order to check if it has been updated. The function and trade-offs of this value are analogous to the TTL of DNS record.
- Implementations MUST include this value inside the DAG-CBOR document at `IpnsEntry.data[TTL]`.
- Suggested default: 1 hour (3 600 000 000 000 nanoseconds).

lidel marked this conversation as resolved.
Show resolved Hide resolved
- **Public Key** (bytes)
- Public key used to sign this record.
Expand Down