Skip to content

Commit f68df0c

Browse files
authored
ipns-record: fix lint, add context for ttl
1 parent 942569e commit f68df0c

File tree

1 file changed

+1
-2
lines changed

1 file changed

+1
-2
lines changed

src/ipns/ipns-record.md

+1-2
Original file line numberDiff line numberDiff line change
@@ -151,11 +151,10 @@ A logical :dfn[IPNS Record] is a data structure containing the following fields:
151151
- Implementations MUST include this value in inside the DAG-CBOR document at `IpnsEntry.data[Sequence]`.
152152

153153
- **TTL** (uint64)
154-
- 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.
154+
- 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.
155155
- Implementations MUST include this value inside the DAG-CBOR document at `IpnsEntry.data[TTL]`.
156156
- Suggested default: 1 hour (3 600 000 000 000 nanoseconds).
157157

158-
159158
- **Public Key** (bytes)
160159
- Public key used to sign this record.
161160
- 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)