docs: changelog and --help

core/commands/name/ipns.go

@@ -73,8 +73,8 @@ Resolve the value of a dnslink:
  Options: []cmds.Option{
  cmds.BoolOption(recursiveOptionName, "r", "Resolve until the result is not an IPNS name.").WithDefault(true),
  cmds.BoolOption(nocacheOptionName, "n", "Do not use cached entries."),
- cmds.UintOption(dhtRecordCountOptionName, "dhtrc", "Number of records to request for DHT resolution."),
- cmds.StringOption(dhtTimeoutOptionName, "dhtt", "Max time to collect values during DHT resolution eg \"30s\". Pass 0 for no timeout."),
+ cmds.UintOption(dhtRecordCountOptionName, "dhtrc", "Number of records to request for DHT resolution.").WithDefault(uint(namesys.DefaultResolverDhtRecordCount)),
+ cmds.StringOption(dhtTimeoutOptionName, "dhtt", "Max time to collect values during DHT resolution eg \"30s\". Pass 0 for no timeout.").WithDefault(namesys.DefaultResolverDhtTimeout.String()),
  cmds.BoolOption(streamOptionName, "s", "Stream entries as they are found."),
  },
  Run: func(req *cmds.Request, res cmds.ResponseEmitter, env cmds.Environment) error {

core/commands/name/publish.go

@@ -11,7 +11,7 @@ import (
 
  iface "github.com/ipfs/boxo/coreiface"
  options "github.com/ipfs/boxo/coreiface/options"
- namesys "github.com/ipfs/boxo/namesys"
+ ipns "github.com/ipfs/boxo/ipns"
  cmds "github.com/ipfs/go-ipfs-cmds"
  ke "github.com/ipfs/kubo/core/commands/keyencode"
 )
@@ -75,8 +75,8 @@ Alternatively, publish an <ipfs-path> using a valid PeerID (as listed by
  Options: []cmds.Option{
  cmds.StringOption(keyOptionName, "k", "Name of the key to be used or a valid PeerID, as listed by 'ipfs key list -l'.").WithDefault("self"),
  cmds.BoolOption(resolveOptionName, "Check if the given path can be resolved before publishing.").WithDefault(true),
- cmds.StringOption(lifeTimeOptionName, "t", `Time duration the signed record will be valid for. Accepts durations such as "300s", "1.5h" or "7d2h45m"`).WithDefault(namesys.DefaultIPNSRecordEOL.String()),
- cmds.StringOption(ttlOptionName, "Time duration hint, akin to --lifetime, indicating how long to cache this record before checking for updates.").WithDefault(namesys.DefaultIPNSRecordTTL.String()),
+ cmds.StringOption(lifeTimeOptionName, "t", `Time duration the signed record will be valid for. Accepts durations such as "300s", "1.5h" or "7d2h45m"`).WithDefault(ipns.DefaultRecordLifetime.String()),
+ cmds.StringOption(ttlOptionName, "Time duration hint, akin to --lifetime, indicating how long to cache this record before checking for updates.").WithDefault(ipns.DefaultRecordTTL.String()),
  cmds.BoolOption(quieterOptionName, "Q", "Write only final IPNS Name encoded as CIDv1 (for use in /ipns content paths)."),
  cmds.BoolOption(v1compatOptionName, "Produce a backward-compatible IPNS Record by including fields for both V1 and V2 signatures.").WithDefault(true),
  cmds.BoolOption(allowOfflineOptionName, "When --offline, save the IPNS record to the the local datastore without broadcasting to the network (instead of failing)."),

docs/changelogs/v0.24.md

@@ -7,6 +7,8 @@
 - [Overview](#overview)
 - [🔦 Highlights](#-highlights)
  - [Gateway: the root of the CARs are no longer meaningful](#gateway-the-root-of-the-cars-are-no-longer-meaningful)
+ - [IPNS: improved publishing defaults](#ipns-improved-publishing-defaults)
+ - [IPNS: record TTL is used for caching](#ipns-record-ttl-is-used-for-caching)
 - [📝 Changelog](#-changelog)
 - [👨‍👩‍👧‍👦 Contributors](#-contributors)
 
@@ -22,6 +24,41 @@ path. However, in situations where the path cannot be resolved, such as when
 the path does not exist, a CAR will be sent with a root of `bafkqaaa` (empty CID).
 This CAR will contain all blocks necessary to validate that the path does not exist.
 
+#### IPNS: improved publishing defaults
+
+This release changes the default values used when publishing IPNS record
+via `ipfs name publish` command:
+
+- Default `--lifetime` increased from `24h` to `48h` to take full advantage of
+ the increased expiration window of Amino DHT
+ ([go-libp2p-kad-dht#793](https:/libp2p/go-libp2p-kad-dht/pull/793))
+- Default `--ttl` increased from `1m` to `1h` to improve website caching and follow
+ saner defaults present in similar systems like DNS
+ ([specs#371](https:/ipfs/specs/pull/371))
+
+This change only impacts the implicit defaults, when mentioned parameters are omitted
+during publishing. Users are free to override the default if different value
+makes more sense for their use case.
+
+#### IPNS: record TTL is used for caching
+
+In this release, we've made significant improvements to IPNS caching.
+
+Previously, the TTL value in IPNS records was not utilized, and the
+`boxo/namesys` library maintained a static one-minute resolution cache.
+
+With this update, IPNS publishers gain more control over how long a valid IPNS
+record remains cached before checking an upstream routing system, such as Amino
+DHT, for updates. The TTL value in the IPNS record now serves as a hint for:
+
+- `boxo/namesys`: the internal cache, determining how long the IPNS resolution
+ result is cached before asking upsteam routing systems for updates.
+- `boxo/gateway`: the `Cache-Control` HTTP header in responses to requests made
+ for `/ipns/name` content paths.
+
+These changes make it easier for rarely updated IPNS-hosted websites to be
+cached more efficiently and load faster in browser contexts.
+
 ### 📝 Changelog
 
 ### 👨‍👩‍👧‍👦 Contributors

docs/examples/kubo-as-a-library/go.mod

@@ -7,7 +7,7 @@ go 1.20
 replace github.com/ipfs/kubo => ./../../..
 
 require (
- github.com/ipfs/boxo v0.13.2-0.20231012133834-3d4e275d44fa
+ github.com/ipfs/boxo v0.13.2-0.20231017213025-3501551b9158
  github.com/ipfs/kubo v0.0.0-00010101000000-000000000000
  github.com/libp2p/go-libp2p v0.31.0
  github.com/multiformats/go-multiaddr v0.11.0

docs/examples/kubo-as-a-library/go.sum

@@ -300,8 +300,8 @@ github.com/ianlancetaylor/demangle v0.0.0-20181102032728-5e5cf60278f6/go.mod h1:
 github.com/inconshreveable/mousetrap v1.0.0/go.mod h1:PxqpIevigyE2G7u3NXJIT2ANytuPF1OarO4DADm73n8=
 github.com/ipfs/bbloom v0.0.4 h1:Gi+8EGJ2y5qiD5FbsbpX/TMNcJw8gSqr7eyjHa4Fhvs=
 github.com/ipfs/bbloom v0.0.4/go.mod h1:cS9YprKXpoZ9lT0n/Mw/a6/aFV6DTjTLYHeA+gyqMG0=
-github.com/ipfs/boxo v0.13.2-0.20231012133834-3d4e275d44fa h1:DeNbyulqibzJG0xtGlQLnDsRaMyHKSKcCLnJNP1fvik=
-github.com/ipfs/boxo v0.13.2-0.20231012133834-3d4e275d44fa/go.mod h1:btrtHy0lmO1ODMECbbEY1pxNtrLilvKSYLoGQt1yYCk=
+github.com/ipfs/boxo v0.13.2-0.20231017213025-3501551b9158 h1:ii9V0BRGKRmYbisKR//ehBcpMVpAPsQqvir5aJQIF1s=
+github.com/ipfs/boxo v0.13.2-0.20231017213025-3501551b9158/go.mod h1:btrtHy0lmO1ODMECbbEY1pxNtrLilvKSYLoGQt1yYCk=
 github.com/ipfs/go-bitfield v1.1.0 h1:fh7FIo8bSwaJEh6DdTWbCeZ1eqOaOkKFI74SCnsWbGA=
 github.com/ipfs/go-bitfield v1.1.0/go.mod h1:paqf1wjq/D2BBmzfTVFlJQ9IlFOZpg422HL0HqsGWHU=
 github.com/ipfs/go-block-format v0.0.2/go.mod h1:AWR46JfpcObNfg3ok2JHDUfdiHRgWhJgCQF+KIgOPJY=

go.mod

@@ -15,7 +15,7 @@ require (
  github.com/fsnotify/fsnotify v1.6.0
  github.com/google/uuid v1.3.1
  github.com/hashicorp/go-multierror v1.1.1
- github.com/ipfs/boxo v0.13.2-0.20231012133834-3d4e275d44fa
+ github.com/ipfs/boxo v0.13.2-0.20231017213025-3501551b9158
  github.com/ipfs/go-block-format v0.2.0
  github.com/ipfs/go-cid v0.4.1
  github.com/ipfs/go-cidutil v0.1.0

go.sum

@@ -335,8 +335,8 @@ github.com/ianlancetaylor/demangle v0.0.0-20181102032728-5e5cf60278f6/go.mod h1:
 github.com/inconshreveable/mousetrap v1.0.0/go.mod h1:PxqpIevigyE2G7u3NXJIT2ANytuPF1OarO4DADm73n8=
 github.com/ipfs/bbloom v0.0.4 h1:Gi+8EGJ2y5qiD5FbsbpX/TMNcJw8gSqr7eyjHa4Fhvs=
 github.com/ipfs/bbloom v0.0.4/go.mod h1:cS9YprKXpoZ9lT0n/Mw/a6/aFV6DTjTLYHeA+gyqMG0=
-github.com/ipfs/boxo v0.13.2-0.20231012133834-3d4e275d44fa h1:DeNbyulqibzJG0xtGlQLnDsRaMyHKSKcCLnJNP1fvik=
-github.com/ipfs/boxo v0.13.2-0.20231012133834-3d4e275d44fa/go.mod h1:btrtHy0lmO1ODMECbbEY1pxNtrLilvKSYLoGQt1yYCk=
+github.com/ipfs/boxo v0.13.2-0.20231017213025-3501551b9158 h1:ii9V0BRGKRmYbisKR//ehBcpMVpAPsQqvir5aJQIF1s=
+github.com/ipfs/boxo v0.13.2-0.20231017213025-3501551b9158/go.mod h1:btrtHy0lmO1ODMECbbEY1pxNtrLilvKSYLoGQt1yYCk=
 github.com/ipfs/go-bitfield v1.1.0 h1:fh7FIo8bSwaJEh6DdTWbCeZ1eqOaOkKFI74SCnsWbGA=
 github.com/ipfs/go-bitfield v1.1.0/go.mod h1:paqf1wjq/D2BBmzfTVFlJQ9IlFOZpg422HL0HqsGWHU=
 github.com/ipfs/go-bitswap v0.11.0 h1:j1WVvhDX1yhG32NTC9xfxnqycqYIlhzEzLXG/cU1HyQ=

test/dependencies/go.mod

@@ -7,7 +7,7 @@ replace github.com/ipfs/kubo => ../../
 require (
  github.com/Kubuxu/gocovmerge v0.0.0-20161216165753-7ecaa51963cd
  github.com/golangci/golangci-lint v1.54.1
- github.com/ipfs/boxo v0.13.2-0.20231012133834-3d4e275d44fa
+ github.com/ipfs/boxo v0.13.2-0.20231017213025-3501551b9158
  github.com/ipfs/go-cid v0.4.1
  github.com/ipfs/go-cidutil v0.1.0
  github.com/ipfs/go-datastore v0.6.0

test/dependencies/go.sum

@@ -398,8 +398,8 @@ github.com/inconshreveable/mousetrap v1.1.0 h1:wN+x4NVGpMsO7ErUn/mUI3vEoE6Jt13X2
 github.com/inconshreveable/mousetrap v1.1.0/go.mod h1:vpF70FUmC8bwa3OWnCshd2FqLfsEA9PFc4w1p2J65bw=
 github.com/ipfs/bbloom v0.0.4 h1:Gi+8EGJ2y5qiD5FbsbpX/TMNcJw8gSqr7eyjHa4Fhvs=
 github.com/ipfs/bbloom v0.0.4/go.mod h1:cS9YprKXpoZ9lT0n/Mw/a6/aFV6DTjTLYHeA+gyqMG0=
-github.com/ipfs/boxo v0.13.2-0.20231012133834-3d4e275d44fa h1:DeNbyulqibzJG0xtGlQLnDsRaMyHKSKcCLnJNP1fvik=
-github.com/ipfs/boxo v0.13.2-0.20231012133834-3d4e275d44fa/go.mod h1:btrtHy0lmO1ODMECbbEY1pxNtrLilvKSYLoGQt1yYCk=
+github.com/ipfs/boxo v0.13.2-0.20231017213025-3501551b9158 h1:ii9V0BRGKRmYbisKR//ehBcpMVpAPsQqvir5aJQIF1s=
+github.com/ipfs/boxo v0.13.2-0.20231017213025-3501551b9158/go.mod h1:btrtHy0lmO1ODMECbbEY1pxNtrLilvKSYLoGQt1yYCk=
 github.com/ipfs/go-bitfield v1.1.0 h1:fh7FIo8bSwaJEh6DdTWbCeZ1eqOaOkKFI74SCnsWbGA=
 github.com/ipfs/go-bitfield v1.1.0/go.mod h1:paqf1wjq/D2BBmzfTVFlJQ9IlFOZpg422HL0HqsGWHU=
 github.com/ipfs/go-block-format v0.2.0 h1:ZqrkxBA2ICbDRbK8KJs/u0O3dlp6gmAuuXUJNiW1Ycs=