Merge pull request #371 from ipfs/new-ipns-ttl-default

Document suggested IPNS Entry TTL default
ipfs · Oct 3, 2023 · 7a4e220 · 7a4e220
2 parents 1a3c260 + f68df0c
commit 7a4e220
Showing 1 changed file with 3 additions and 2 deletions.
diff --git a/src/ipns/ipns-record.md b/src/ipns/ipns-record.md
@@ -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
@@ -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).
 
 - **Public Key** (bytes)
   - Public key used to sign this record.