Skip to content

Commit 2c925f9

Browse files
committed
docs: add suggested default 12h for IPNS Entry TTL
1 parent 80db667 commit 2c925f9

File tree

1 file changed

+2
-1
lines changed

1 file changed

+2
-1
lines changed

ipns/IPNS.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -140,8 +140,9 @@ A logical IPNS record is a data structure containing the following fields:
140140
- Represents the current version of the record (starts at 0).
141141
- Implementations MUST include this value in both `IpnsEntry.sequence` and inside the DAG-CBOR document at `IpnsEntry.data[sequence]`.
142142
- **TTL** (uint64)
143-
- 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.
143+
- 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.
144144
- Implementations MUST include this value in both `IpnsEntry.ttl` and inside the DAG-CBOR document at `IpnsEntry.data[ttl]`.
145+
- Suggested default: 12 hours (43 200 000 000 000 nanosecdonds).
145146
- **Public Key** (bytes)
146147
- Public key used to sign this record.
147148
- 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)