861c3f803 · cryptotaxi247/kubo · siGit Code & Deploy

@@ -19,8 +19,8 @@ Below is an outline of all that is in this release, so you get a sense of all th

19 - [QUIC and WebTransport](#quic-and-webtransport)

20 - [WebTransport enabled by default](#webtransport-enabled-by-default)

21 - [QUIC and WebTransport share a single port](#quic-and-webtransport-share-a-single-port)

22 + - [Differentiating QUIC versions](#differentiating-quic-versions)

23 - [QUICv1 and WebTransport config migration](#quicv1-and-webtransport-config-migration)

23 - - [/quic draft-29 deprecation notice](#quic-draft-29-deprecation-notice)

24 - [Improving libp2p resource management integration](#improving-libp2p-resource-management-integration)

25 - [📝 Changelog](#-changelog)

26 - [👨‍👩‍👧‍👦 Contributors](#%E2%80%8D%E2%80%8D%E2%80%8D-contributors)

@@ -35,10 +35,11 @@ Below is an outline of all that is in this release, so you get a sense of all th

35

36 Content routing is the process of discovering which peers provide a piece of content. Kubo has traditionally only supported [libp2p's implementation of Kademlia DHT](https://github.com/libp2p/specs/tree/master/kad-dht) for content routing.

37

38 -Kubo can now bridge networks by including support for the [delegated routing HTTP API](https://github.com/ipfs/specs/pull/337). Users can compose content routers using the `Routing.Routers` config, to pick content routers with different tradeoffs than a Kademlia DHT (for example, high-performance and high-capacity centralized endpoints, dedicated Kademlia DHT nodes, routers with unique provider records, privacy-focused content routers, etc.).

38 +Kubo can now bridge networks by including support for the [delegated routing HTTP API](https://github.com/ipfs/specs/pull/337). Users can compose content routers using the `Routing.Routers` config to pick content routers with different tradeoffs than a Kademlia DHT (e.g., high-performance and high-capacity centralized endpoints, dedicated Kademlia DHT nodes, routers with unique provider records, privacy-focused content routers).

39

40 One example is [InterPlanetary Network Indexers](https://github.com/ipni/specs/blob/main/IPNI.md#readme), which are HTTP endpoints that cache records from both the IPFS network and other sources such as web3.storage and Filecoin. This improves not only content availability by enabling Kubo to transparently fetch content directly from Filecoin storage providers, but also improves IPFS content routing latency by an order of magnitude and decreases resource consumption.

41 -*Note:* it's possible to retrieve content stored by Filecoin Storage Providers (SPs) from Kubo if the SPs service Bitswap requests. As of this release, some SPs are advertising Bitswap. You can follow the roadmap progress for IPNIs and Bitswap in SPs [here](https://www.starmaps.app/roadmap/github.com/protocol/bedrock/issues/1).

41 +

42 +> *Note:* it's possible to retrieve content stored by Filecoin Storage Providers (SPs) from Kubo if the SPs service Bitswap requests. As of this release, some SPs are advertising Bitswap. You can follow the roadmap progress for IPNIs and Bitswap in SPs [here](https://www.starmaps.app/roadmap/github.com/protocol/bedrock/issues/1).

43

44 In this release, the default content router is changed from `dht` to `auto`. The `auto` router includes the IPFS DHT in addition to the [cid.contact](https://cid.contact) IPNI instance. In future releases, we plan to expand the functionality of `auto` to encompass automatic discovery of content routers, which will improve performance and content availability (for example, see [IPIP-342](https://github.com/ipfs/specs/pull/342)).

45

@@ -46,25 +47,25 @@ Previous behavior can be restored by setting `Routing.Type` to `dht`.

47

48 Alternative routing rules, including alternative IPNI endpoints, can be configured in `Routing.Routers` after setting `Routing.Type` to `custom`.

49

49 -Learn more in [`Routing` docs](https://github.com/ipfs/kubo/blob/master/docs/config.md#routing).

50 +Learn more in the [`Routing` docs](https://github.com/ipfs/kubo/blob/master/docs/config.md#routing).

51

52 ##### Increase provider record republish interval and expiration

53

54 Default `Reprovider.Interval` changed from 12h to 22h to match new defaults for the Provider Record Expiration (48h) in [go-libp2p-kad-dht v0.20.0](https://github.com/libp2p/go-libp2p-kad-dht/releases/tag/v0.20.0).

55

55 -Rationale for increasing this can be found in

56 +The rationale for increasing this can be found in

57 [RFM 17: Provider Record Livenes Report](https://github.com/protocol/network-measurements/blob/master/results/rfm17-provider-record-liveness.md),

58 [kubo#9326](https://github.com/ipfs/kubo/pull/9326),

59 and the upstream DHT specifications at [libp2p/specs#451](https://github.com/libp2p/specs/pull/451).

60

60 -Learn more: [`Reprovider` config](https://github.com/ipfs/go-ipfs/blob/master/docs/config.md#reprovider)

61 +Learn more in the [`Reprovider` config](https://github.com/ipfs/go-ipfs/blob/master/docs/config.md#reprovider).

62

63 #### Gateways

64

65 ##### (DAG-)JSON and (DAG-)CBOR response formats

66

67 Implemented [IPIP-328](https://github.com/ipfs/specs/pull/328) which adds support

67 -to DAG-JSON and DAG-CBOR, as well as their non-DAG variants, to the gateway. Now,

68 +for DAG-JSON and DAG-CBOR, as well as their non-DAG variants, to the gateway. Now,

69 CIDs that encode JSON, CBOR, DAG-JSON and DAG-CBOR objects can be retrieved, and

70 traversed thanks to the [special meaning of CBOR Tag 42](https://github.com/ipld/cid-cbor/).

71

@@ -120,44 +121,39 @@ There is no linear slowdown caused by reading size metadata from child nodes,

121 and the size of DAG representing child items is always present.

122

123 As an example, the CID

123 -`bafybeiggvykl7skb2ndlmacg2k5modvudocffxjesexlod2pfvg5yhwrqm` represents UnixFS

124 -directory with over 10k (10100) of files. Listing big directories was fast

124 +`bafybeiggvykl7skb2ndlmacg2k5modvudocffxjesexlod2pfvg5yhwrqm` represents a UnixFS

125 +directory with over 10k files. Listing big directories was fast

126 since Kubo 0.13, but in this release it will also include the size column.

127

128 #### QUIC and WebTransport

129

130 ##### WebTransport enabled by default

130 -

131 -[WebTransport](https://github.com/libp2p/go-libp2p/issues/1717) is a new libp2p transport that [has been introduced in v0.16](v0.16.md#-webtransport-new-experimental-transport) that is based on top of QUIC and HTTP3.

131 +[WebTransport](https://docs.libp2p.io/concepts/transports/webtransport/) is a new libp2p transport that [was introduced in v0.16](https://github.com/ipfs/kubo/blob/master/docs/changelogs/v0.16.md#-webtransport-new-experimental-transport) that is based on top of QUIC and HTTP3.

132

133 This allows browsers to contact Kubo nodes, so now instead of just serving requests for other system level applicative nodes, you can also serve requests directly to a browser.

134 +

135 For the full story see [connectivity.libp2p.io](https://connectivity.libp2p.io/).

136

137 ##### QUIC and WebTransport share a single port

138 +WebTransport is enabled by default in part because [go-libp2p now supports running WebTransport and QUIC transports on the same QUIC listener](https://github.com/libp2p/go-libp2p/issues/1759). No additional port needs to be opened.

139

138 -The new feature that allows us to ship WebTransport by default is that [go-libp2p now supports running WebTransport and QUIC transports on the same QUIC listener](https://github.com/libp2p/go-libp2p/issues/1759).

139 -

140 -To use this feature, you just have to register two listen address on the same `/ipX/.../udp/XXX` prefix.

141 -

142 -##### QUICv1 and WebTransport config migration

140 +To use this feature, register two listen addresses on the same `/ipX/.../udp/XXX` prefix.

141

144 -Go-libp2p now differentiate the first version of QUIC we implemented (and were using until then), `Draft-29`, and the ratified protocol in RFC9000, `QUICv1`.

145 -This manifest as two different multiaddr components `/quic` (old Draft-29) and `/quic-v1`.

142 +##### Differentiating QUIC versions

143 +go-libp2p now differentiates the first version of QUIC that was originally implemented, `Draft-29`, from the ratified protocol in [RFC9000](https://www.rfc-editor.org/rfc/rfc9000.html), `QUICv1`.

144 +This was done for performance (time to first byte) reasons as [outlined here](https://github.com/multiformats/multiaddr/issues/145).

145

147 -Even tho Draft-29 and QUICv1 are similar they are not fully inter-compatible, go-libp2p do supports listening with both versions on one single listener.

146 +This manifests as two different multiaddr components `/quic` (old Draft-29) and `/quic-v1`.

147 +go-libp2p do supports listening with both QUIC versions on one single listener.

148 +WebTransport has only supported QUICv1.

149 +`/webtransport` now needs to be prefixed by a `/quic-v1` component instead of a `/quic` component.

150

149 -`/webtransport` now also need to be prefixed by a `/quic-v1` instead of `/quic` component.

150 -This has no protocol change, WebTransport only supports QUICv1 and were running on QUICv1 already.

151 +Support for QUIC Draft-29 will be removed at some point in 2023 ([tracking issue](https://github.com/ipfs/kubo/issues/9496)). As a result, new deployements should use `/quic-v1` instead of `/quic`.

152

152 -To support QUICv1 and WebTransport by default we run a new migration (n°`13`) which automatically add entries in addresses related fields in the config:

153 +##### QUICv1 and WebTransport config migration

154 +To support QUICv1 and WebTransport by default a new config migration (`v13`) is run which automatically adds entries in addresses-related fields:

155 - Replace all `/quic/webtransport` to `/quic-v1/webtransport`.

154 -- For all `/quic` listener, keep the Draft-29 listener, and on the same ip and port, add `/quic-v1` and `/quic-v1/webtransport` listeners.

155 -

156 -##### `/quic` (draft-29) deprecation notice

157 -

158 -We plan to remove support for QUIC Draft-29 in the mid to long term future.

159 -

160 -You must not use `/quic` for new deployements and use `/quic-v1` instead.

156 +- For all `/quic` listeners, keep the Draft-29 listener, and on the same ip and port, add `/quic-v1` and `/quic-v1/webtransport` listeners.

157

158 #### Improving libp2p resource management integration

159 To help protect nodes from DoS (resource exhaustion) and eclipse attacks,

Cleaned up content