Skip to content

Commit

Permalink
docs: add suggested default 12h for IPNS Entry TTL
Browse files Browse the repository at this point in the history
  • Loading branch information
hacdias committed Oct 3, 2023
1 parent 1a3c260 commit f7c35a7
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions src/ipns/ipns-record.md
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,9 +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.
- Implementations MUST include this value inside the DAG-CBOR document at `IpnsEntry.data[TTL]`.

- Suggested default: 12 hours (43 200 000 000 000 nanoseconds).
- **Public Key** (bytes)
- Public key used to sign this record.
- If public key is small enough to fit in IPNS name (e.g., Ed25519 keys inlined using `identity` multihash), `IpnsEntry.pubKey` field is redundant and MAY be skipped to save space.
Expand Down

0 comments on commit f7c35a7

Please sign in to comment.