Skip to content

Commit

Permalink
Update ipns.md
Browse files Browse the repository at this point in the history
  • Loading branch information
lidel authored Feb 26, 2025
1 parent 0e21b18 commit e795418
Showing 1 changed file with 4 additions and 3 deletions.
7 changes: 4 additions & 3 deletions docs/concepts/ipns.md
Original file line number Diff line number Diff line change
Expand Up @@ -198,11 +198,12 @@ You should have the ability to override the TTL provided by the publisher and se

#### Practical considerations

One of the most important things to consider with IPNS names is **how frequently you intend on updating the name**.
The most important thing to consider with IPNS names is **how frequently you intend on updating the name** and **how long a valid record should be cached before checking for an update**.

Practically, two levers within your control determine where your IPNS name is on the spectrum between consistency and availability:
Practically, levers within your control determine where your IPNS name is on the spectrum between consistency and availability:

- **IPNS record validity:** longer validity will veer towards availability. Moreover, longer validity will reduce the dependence on the key holder (which for most purposes is stored on a single machine and rare shared) since the record can continue to persist without requiring the private key holder to sign a new record. Another benefit of a longer validity is that the transport can be delegated to other nodes or services (such as [w3name](https://staging.web3.storage/docs/how-tos/w3name/)), without compromising the private key.
- **IPNS record validity:** longer validity will veer towards availability. Moreover, longer validity will reduce the dependence on the key holder (which for most purposes is stored on a single machine and rare shared) since the record can continue to persist without requiring the private key holder to sign a new record. Another benefit of a longer validity is that the transport can be delegated to other nodes or services (such as [w3name](https://docs.storacha.network/how-to/w3name/)), without compromising the private key.
- **IPNS record TTL:** longer TTL wil trade update propagation speed for better page load performance and resiliency.

Check failure on line 206 in docs/concepts/ipns.md

View workflow job for this annotation

GitHub Actions / pr-content-check

[vale] reported by reviewdog 🐶 [docs.PLNSpelling] Did you really mean 'wil'? Raw Output: {"message": "[docs.PLNSpelling] Did you really mean 'wil'?", "location": {"path": "docs/concepts/ipns.md", "range": {"start": {"line": 206, "column": 35}}}, "severity": "ERROR"}
- **Transport mechanism:** the DHT veers towards consistency while PubSub veers towards availability. However, with Kubo, IPNS names are always published to the DHT, while PubSub is opt-in. For most purposes, enabling PubSub is a net gain unless you hit the upper limit of connections as a result of too many PubSub subscriptions.

## IPNS in practice
Expand Down

0 comments on commit e795418

Please sign in to comment.