Skip to content

Latest commit

 

History

History
337 lines (283 loc) · 23.3 KB

v0.30.md

File metadata and controls

337 lines (283 loc) · 23.3 KB
Raw

Kubo changelog v0.30

v0.30.0

Overview

🔦 Highlights

This release took longer and is more packed with fixes and features than usual.

Important

TLDR: update, it contains many, many fixes.

Improved P2P connectivity

This release comes with significant go-libp2p update from v0.34.1 to v0.36.3 (release notes).

It includes multiple fixes to key protocols: QUIC/Webtransport/WebRTC, Connection Upgrades through Relay (DCUtR), and Secure WebSockets.

Also, peers that are behind certain types of NAT will now be more reachable. For this alone, Kubo users are highly encouraged to upgrade.

Refactored Bitswap and dag-pb chunker

Some workloads may experience improved memory profile thanks to optimizations from Boxo SDK v0.23.0.

Important

Storage providers should upgrade to take advantage of the Bitswap server fix, which resolves the issue of greedy peers depleting available wantlist slots for their PeerID, resulting in stalled downloads.

WebRTC-Direct Transport enabled by default

Kubo now ships with WebRTC Direct listener enabled by default: /udp/4001/webrtc-direct.

WebRTC Direct complements existing /wss (Secure WebSockets) and /webtransport transports. Unlike /wss, which requires a domain name and a CA-issued TLS certificate, WebRTC Direct works with IPs and can be enabled by default on all Kubo nodes.

Learn more: Swarm.Transports.Network.WebRTCDirect

Note

Kubo 0.30 includes a migration for existing users that adds /webrtc-direct listener on the same UDP port as /udp/{port}/quic-v1. This supports the WebRTC-Direct rollout by reusing preexisting UDP firewall settings and port mappings created for QUIC.

UnixFS 1.5: Mode and Modification Time Support

Kubo now allows users to opt-in to store mode and modification time for files, directories, and symbolic links. By default, if you do not opt-in, the old behavior remains unchanged, and the same CIDs will be generated as before.

The ipfs add CLI options --preserve-mode and --preserve-mtime can be used to store the original mode and last modified time of the file being added, and ipfs files stat /ipfs/CID can be used for inspecting these optional attributes:

$ touch ./file
$ chmod 654 ./file
$ ipfs add --preserve-mode --preserve-mtime -Q ./file
QmczQr4XS1rRnWVopyg5Chr9EQ7JKpbhgnrjpb5kTQ1DKQ

$ ipfs files stat /ipfs/QmczQr4XS1rRnWVopyg5Chr9EQ7JKpbhgnrjpb5kTQ1DKQ
QmczQr4XS1rRnWVopyg5Chr9EQ7JKpbhgnrjpb5kTQ1DKQ
Size: 0
CumulativeSize: 22
ChildBlocks: 0
Type: file
Mode: -rw-r-xr-- (0654)
Mtime: 13 Aug 2024, 21:15:31 UTC

The CLI and HTTP RPC options --mode, --mtime and --mtime-nsecs can be used to set them to arbitrary values.

Opt-in support for mode and mtime was also added to MFS (ipfs files --help). For more information see --help text of ipfs files touch|stat|chmod commands.

Modification time support was also added to the Gateway. If present, value from file's dag-pb is returned in Last-Modified HTTP header and requests made with If-Modified-Since can produce HTTP 304 not modified response.

Note

Storing mode and mtime requires root block to be dag-pb and disabled raw-leaves setting to create envelope for storing the metadata.

AutoNAT V2 Service Introduced Alongside V1

The AutoNAT service enables nodes to determine their public reachability on the internet. AutoNAT V2 enhances this protocol with improved features. In this release, Kubo will offer both V1 and V2 services to other peers, although it will continue to use only V1 when acting as a client. Future releases will phase out V1, transitioning clients to utilize V2 exclusively.

For more details, see the Deployment Plan for AutoNAT V2 and AutoNAT configuration options.

Automated ipfs version check

Kubo now performs privacy-preserving version checks using the libp2p identify protocol on peers detected by the Amino DHT client. If more than 5% of Kubo peers seen by your node are running a newer version, you will receive a log message notification.

  • For manual checks, refer to ipfs version check --help for details.
  • To disable automated checks, set Version.SwarmCheckEnabled to false.

Version Suffix Configuration

Defining the optional agent version suffix is now simpler. The Version.AgentSuffix value from the Kubo config takes precedence over any value provided via ipfs daemon --agent-version-suffix (which is still supported).

Note

Setting a custom version suffix helps with ecosystem analysis, such as Amino DHT reports published at https://stats.ipfs.network

/unix/ socket support in Addresses.API

This release fixes a bug which blocked users from using Unix domain sockets for Kubo's RPC (instead of a local HTTP port).

$ ipfs config Addresses.API "/unix/tmp/kubo.socket"
$ ipfs daemon # start with rpc socket
...
RPC API server listening on /unix/tmp/kubo.socket

$ # cli client, in different terminal can find socket via /api file
$ cat $IPFS_PATH/api
/unix/tmp/kubo.socket

$ # or have it pased via --api
$ ipfs --api=/unix/tmp/kubo.socket id

Cleaned Up ipfs daemon Startup Log

The ipfs daemon startup output has been streamlined to enhance clarity and usability:

$ ipfs daemon
Initializing daemon...
Kubo version: 0.30.0
Repo version: 16
System version: amd64/linux
Golang version: go1.22.5
PeerID: 12D3KooWQ73s1CQsm4jWwQvdCAtc5w8LatyQt7QLQARk5xdhK9CE
Swarm listening on 127.0.0.1:4001 (TCP+UDP)
Swarm listening on 192.0.2.10:4001 (TCP+UDP)
Swarm listening on [::1]:4001 (TCP+UDP)
Swarm listening on [2001:0db8::10]:4001 (TCP+UDP)
Run 'ipfs id' to inspect announced and discovered multiaddrs of this node.
RPC API server listening on /ip4/127.0.0.1/tcp/5001
WebUI: http://127.0.0.1:5001/webui
Gateway server listening on /ip4/127.0.0.1/tcp/8080
Daemon is ready

The previous lengthy listing of all listener and announced multiaddrs has been removed due to its complexity, especially with modern libp2p nodes sharing multiple transports and long lists of /webtransport and /webrtc-direct certhashes. The output now features a simplified list of swarm listeners, displayed in the format host:port (TCP+UDP), which provides essential information for debugging connectivity issues, particularly related to port forwarding. Announced libp2p addresses are no longer printed on startup, because libp2p may change or augument them based on AutoNAT, relay, and UPnP state. Instead, users are prompted to run ipfs id to obtain up-to-date list of listeners and announced multiaddrs in libp2p format.

Commands Preserve Specified Hostname

When executing a CLI command over Kubo RPC API, if a hostname is specified by --api=/dns4/<domain>/ the resulting HTTP request now contains the hostname, instead of the the IP address that the hostname resolved to, as was the previous behavior. This makes it easier for those trying to run Kubo behind a reverse proxy using hostname-based rules.

📝 Changelog

Full Changelog

👨‍👩‍👧‍👦 Contributors

Contributor Commits Lines ± Files Changed
Andrew Gillis 14 +4920/-1714 145
sukun 26 +4402/-448 79
Marco Munizaga 32 +2287/-536 73
Marcin Rataj 41 +685/-193 86
Patryk 1 +312/-10 8
guillaumemichel 7 +134/-105 14
Adin Schmahmann 5 +145/-80 9
Henrique Dias 2 +190/-1 6
Josh Klopfenstein 1 +90/-35 27
gammazero 5 +90/-28 11
Jeromy Johnson 1 +116/-0 5
Daniel N 3 +27/-25 9
Daniel Norman 2 +28/-19 4
Ivan Shvedunov 2 +25/-10 2
Michael Muré 2 +22/-9 4
Dominic Della Valle 1 +23/-4 1
Andrei Vukolov 1 +27/-0 1
chris erway 1 +9/-9 9
Vitaly Zdanevich 1 +12/-0 1
Guillaume Michel 1 +4/-7 1
swedneck 1 +10/-0 1
Jorropo 2 +5/-5 3
omahs 1 +4/-4 4
THAT ONE GUY 1 +3/-5 2
vyzo 1 +5/-2 1
looklose 1 +3/-3 2
web3-bot 2 +2/-3 4
Dave Huseby 1 +5/-0 1
shenpengfeng 1 +1/-1 1
bytetigers 1 +1/-1 1
Sorin Stanculeanu 1 +1/-1 1
Lukáš Lukáč 1 +1/-1 1
Gabe 1 +1/-1 1
Bryan Stenson 1 +1/-1 1
Samy Fodil 1 +1/-0 1
Lane Rettig 1 +1/-0 1