From af0535cff63733c68908ef866d1f6e2e2b701bbe Mon Sep 17 00:00:00 2001 From: Alexandru Vasile <60601340+lexnv@users.noreply.github.com> Date: Mon, 4 Nov 2024 18:48:21 +0200 Subject: [PATCH] chore: Release litep2p version 0.8.0 (#280) ## [0.8.0] - 2024-11-01 This release adds support for content provider advertisement and discovery to Kademlia protocol implementation (see libp2p [spec](https://github.com/libp2p/specs/blob/master/kad-dht/README.md#content-provider-advertisement-and-discovery)). Additionally, the release includes several improvements and memory leak fixes to enhance the stability and performance of the litep2p library. ### Added - kad: Providers part 8: unit, e2e, and `libp2p` conformance tests ([#258](https://github.com/paritytech/litep2p/pull/258)) - kad: Providers part 7: better types and public API, public addresses & known providers ([#246](https://github.com/paritytech/litep2p/pull/246)) - kad: Providers part 6: stop providing ([#245](https://github.com/paritytech/litep2p/pull/245)) - kad: Providers part 5: `GET_PROVIDERS` query ([#236](https://github.com/paritytech/litep2p/pull/236)) - kad: Providers part 4: refresh local providers ([#235](https://github.com/paritytech/litep2p/pull/235)) - kad: Providers part 3: publish provider records (start providing) ([#234](https://github.com/paritytech/litep2p/pull/234)) ### Changed - transport_service: Improve connection stability by downgrading connections on substream inactivity ([#260](https://github.com/paritytech/litep2p/pull/260)) - transport: Abort canceled dial attempts for TCP, WebSocket and Quic ([#255](https://github.com/paritytech/litep2p/pull/255)) - kad/executor: Add timeout for writting frames ([#277](https://github.com/paritytech/litep2p/pull/277)) - kad: Avoid cloning the `KademliaMessage` and use reference for `RoutingTable::closest` ([#233](https://github.com/paritytech/litep2p/pull/233)) - peer_state: Robust state machine transitions ([#251](https://github.com/paritytech/litep2p/pull/251)) - address_store: Improve address tracking and add eviction algorithm ([#250](https://github.com/paritytech/litep2p/pull/250)) - kad: Remove unused serde cfg ([#262](https://github.com/paritytech/litep2p/pull/262)) - req-resp: Refactor to move functionality to dedicated methods ([#244](https://github.com/paritytech/litep2p/pull/244)) - transport_service: Improve logs and move code from tokio::select macro ([#254](https://github.com/paritytech/litep2p/pull/254)) ### Fixed - tcp/websocket/quic: Fix cancel memory leak ([#272](https://github.com/paritytech/litep2p/pull/272)) - transport: Fix pending dials memory leak ([#271](https://github.com/paritytech/litep2p/pull/271)) - ping: Fix memory leak of unremoved `pending_opens` ([#274](https://github.com/paritytech/litep2p/pull/274)) - identify: Fix memory leak of unused `pending_opens` ([#273](https://github.com/paritytech/litep2p/pull/273)) - kad: Fix not retrieving local records ([#221](https://github.com/paritytech/litep2p/pull/221)) --------- Signed-off-by: Alexandru Vasile Co-authored-by: Dmitry Markin --- CHANGELOG.md | 56 ++++++++++++++++++++++++++++++++++++++++++++++++++++ Cargo.lock | 2 +- Cargo.toml | 2 +- 3 files changed, 58 insertions(+), 2 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index ce60aaab..a1d83a23 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -5,6 +5,62 @@ All notable changes to this project will be documented in this file. The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). +## [0.8.0] - 2024-11-04 + +This release adds support for content provider advertisement and discovery to Kademlia protocol implementation (see libp2p [spec](https://github.com/libp2p/specs/blob/master/kad-dht/README.md#content-provider-advertisement-and-discovery)). +Additionally, the release includes several improvements and memory leak fixes to enhance the stability and performance of the litep2p library. + +### [Content Provider Advertisement and Discovery](https://github.com/paritytech/litep2p/pull/234) + +Litep2p now supports content provider advertisement and discovery through the Kademlia protocol. +Content providers can publish their records to the network, and other nodes can discover and retrieve these records using the `GET_PROVIDERS` query. + +```rust + // Start providing a record to the network. + // This stores the record in the local provider store and starts advertising it to the network. + kad_handle.start_providing(key.clone()); + + // Wait for some condition to stop providing... + + // Stop providing a record to the network. + // The record is removed from the local provider store and stops advertising it to the network. + // Please note that the record will be removed from the network after the TTL expires. + kad_provider.stop_providing(key.clone()); + + // Retrieve providers for a record from the network. + // This returns a query ID that is later producing the result when polling the `Kademlia` instance. + let query_id = kad_provider.get_providers(key.clone()); +``` + +### Added + +- kad: Providers part 8: unit, e2e, and `libp2p` conformance tests ([#258](https://github.com/paritytech/litep2p/pull/258)) +- kad: Providers part 7: better types and public API, public addresses & known providers ([#246](https://github.com/paritytech/litep2p/pull/246)) +- kad: Providers part 6: stop providing ([#245](https://github.com/paritytech/litep2p/pull/245)) +- kad: Providers part 5: `GET_PROVIDERS` query ([#236](https://github.com/paritytech/litep2p/pull/236)) +- kad: Providers part 4: refresh local providers ([#235](https://github.com/paritytech/litep2p/pull/235)) +- kad: Providers part 3: publish provider records (start providing) ([#234](https://github.com/paritytech/litep2p/pull/234)) + +### Changed + +- transport_service: Improve connection stability by downgrading connections on substream inactivity ([#260](https://github.com/paritytech/litep2p/pull/260)) +- transport: Abort canceled dial attempts for TCP, WebSocket and Quic ([#255](https://github.com/paritytech/litep2p/pull/255)) +- kad/executor: Add timeout for writting frames ([#277](https://github.com/paritytech/litep2p/pull/277)) +- kad: Avoid cloning the `KademliaMessage` and use reference for `RoutingTable::closest` ([#233](https://github.com/paritytech/litep2p/pull/233)) +- peer_state: Robust state machine transitions ([#251](https://github.com/paritytech/litep2p/pull/251)) +- address_store: Improve address tracking and add eviction algorithm ([#250](https://github.com/paritytech/litep2p/pull/250)) +- kad: Remove unused serde cfg ([#262](https://github.com/paritytech/litep2p/pull/262)) +- req-resp: Refactor to move functionality to dedicated methods ([#244](https://github.com/paritytech/litep2p/pull/244)) +- transport_service: Improve logs and move code from tokio::select macro ([#254](https://github.com/paritytech/litep2p/pull/254)) + +### Fixed + +- tcp/websocket/quic: Fix cancel memory leak ([#272](https://github.com/paritytech/litep2p/pull/272)) +- transport: Fix pending dials memory leak ([#271](https://github.com/paritytech/litep2p/pull/271)) +- ping: Fix memory leak of unremoved `pending_opens` ([#274](https://github.com/paritytech/litep2p/pull/274)) +- identify: Fix memory leak of unused `pending_opens` ([#273](https://github.com/paritytech/litep2p/pull/273)) +- kad: Fix not retrieving local records ([#221](https://github.com/paritytech/litep2p/pull/221)) + ## [0.7.0] - 2024-09-05 This release introduces several new features, improvements, and fixes to the litep2p library. Key updates include enhanced error handling, configurable connection limits, and a new API for managing public addresses. diff --git a/Cargo.lock b/Cargo.lock index 8ee8eb03..15dbb983 100644 --- a/Cargo.lock +++ b/Cargo.lock @@ -2866,7 +2866,7 @@ checksum = "78b3ae25bc7c8c38cec158d1f2757ee79e9b3740fbc7ccf0e59e4b08d793fa89" [[package]] name = "litep2p" -version = "0.7.0" +version = "0.8.0" dependencies = [ "async-trait", "asynchronous-codec 0.7.0", diff --git a/Cargo.toml b/Cargo.toml index 53341116..3c278b23 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -2,7 +2,7 @@ name = "litep2p" description = "Peer-to-peer networking library" license = "MIT" -version = "0.7.0" +version = "0.8.0" edition = "2021" [build-dependencies]