Skip to content

Commit ec6778f

Browse files
committed
docs: add suggested default 12h for IPNS Entry TTL
1 parent 6ca307c commit ec6778f

File tree

1 file changed

+3
-2
lines changed

1 file changed

+3
-2
lines changed

src/ipns/ipns-record.md

+3-2
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
maturity: reliable
3-
date: 2023-02-13
3+
date: 2023-04-05
44
editors:
55
- name: Vasco Santos
66
github: vasco-santos
@@ -127,8 +127,9 @@ A logical IPNS record is a data structure containing the following fields:
127127
- Represents the current version of the record (starts at 0).
128128
- Implementations MUST include this value in both `IpnsEntry.sequence` and inside the DAG-CBOR document at `IpnsEntry.data[sequence]`.
129129
- **TTL** (uint64)
130-
- 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.
130+
- 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.
131131
- Implementations MUST include this value in both `IpnsEntry.ttl` and inside the DAG-CBOR document at `IpnsEntry.data[ttl]`.
132+
- Suggested default: 12 hours (43 200 000 000 000 nanoseconds).
132133
- **Public Key** (bytes)
133134
- Public key used to sign this record.
134135
- 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.

0 commit comments

Comments
 (0)