Skip to content

Latest commit

 

History

History
374 lines (259 loc) · 20.2 KB

CHANGELOG.md

File metadata and controls

374 lines (259 loc) · 20.2 KB
Raw

Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

[0.8.1] - 2024-11-14

This release includes key fixes that enhance the stability and performance of the litep2p library, focusing on long-running stability and improvements to polling mechanisms.

Long Running Stability Improvements

This issue caused long-running nodes to reject all incoming connections, impacting overall stability.

Addressed a bug in the connection limits functionality that incorrectly tracked connections due for rejection. This issue caused an artificial increase in inbound peers, which were not being properly removed from the connection limit count. This fix ensures more accurate tracking and management of peer connections #286.

Polling implementation fixes

This release provides multiple fixes to the polling mechanism, improving how connections and events are processed:

  • Resolved an overflow issue in TransportContext's polling index for streams, preventing potential crashes.
  • Fixed a delay in the manager's poll_next function that prevented immediate polling of newly added futures.
  • Corrected an issue where the listener did not return Poll::Ready(None) when it was closed, ensuring proper signal handling.

Fixed

  • manager: Fix connection limits tracking of rejected connections (#286)
  • transport: Fix waking up on filtered events from poll_next (#287)
  • transports: Fix missing Poll::Ready(None) event from listenener (#285)
  • manager: Avoid overflow on stream implementation for TransportContext (#283)
  • manager: Log when polling returns Ready(None) (#284)

[0.8.0] - 2024-11-04

This release adds support for content provider advertisement and discovery to Kademlia protocol implementation (see libp2p spec). 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

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.

    // 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)
  • kad: Providers part 7: better types and public API, public addresses & known providers (#246)
  • kad: Providers part 6: stop providing (#245)
  • kad: Providers part 5: GET_PROVIDERS query (#236)
  • kad: Providers part 4: refresh local providers (#235)
  • kad: Providers part 3: publish provider records (start providing) (#234)

Changed

  • transport_service: Improve connection stability by downgrading connections on substream inactivity (#260)
  • transport: Abort canceled dial attempts for TCP, WebSocket and Quic (#255)
  • kad/executor: Add timeout for writting frames (#277)
  • kad: Avoid cloning the KademliaMessage and use reference for RoutingTable::closest (#233)
  • peer_state: Robust state machine transitions (#251)
  • address_store: Improve address tracking and add eviction algorithm (#250)
  • kad: Remove unused serde cfg (#262)
  • req-resp: Refactor to move functionality to dedicated methods (#244)
  • transport_service: Improve logs and move code from tokio::select macro (#254)

Fixed

  • tcp/websocket/quic: Fix cancel memory leak (#272)
  • transport: Fix pending dials memory leak (#271)
  • ping: Fix memory leak of unremoved pending_opens (#274)
  • identify: Fix memory leak of unused pending_opens (#273)
  • kad: Fix not retrieving local records (#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.

Exposing Public Addresses API

A new PublicAddresses API has been added, enabling users to manage the node's public addresses. This API allows developers to add, remove, and retrieve public addresses, which are shared with peers through the Identify protocol.

    // Public addresses are accessible from the main litep2p instance.
    let public_addresses = litep2p.public_addresses();

    // Add a new public address to the node.
    if let Err(err) = public_addresses.add_address(multiaddr) {
        eprintln!("Failed to add public address: {:?}", err);
    }

    // Remove a public address from the node.
    public_addresses.remove_address(&multiaddr);

    // Retrieve all public addresses of the node.
    for address in public_addresses.get_addresses() {
        println!("Public address: {}", address);
    }

Breaking Change: The Identify protocol no longer includes public addresses in its configuration. Instead, use the new PublicAddresses API.

Migration Guide:

    // Before:
    let (identify_config, identify_event_stream) = IdentifyConfig::new(
        "/substrate/1.0".to_string(),
        Some(user_agent),
        config.public_addresses,
    );

    // After:
    let (identify_config, identify_event_stream) =
        IdentifyConfig::new("/substrate/1.0".to_string(), Some(user_agent));
    // Public addresses must now be added using the `PublicAddresses` API:
    for address in config.public_addresses {
        if let Err(err) = public_addresses.add_address(address) {
            eprintln!("Failed to add public address: {:?}", err);
        }
    }

Dial Error and List Dial Failures Event

The DialFailure event has been enhanced with a new DialError enum for more precise error reporting when a dial attempt fails. Additionally, a ListDialFailures event has been introduced, listing all dialed addresses and their corresponding errors when multiple addresses are involved.

Other litep2p errors, such as ParseError, AddressError, and NegotiationError, have been refactored for improved error propagation.

Immediate Dial Error and Request-Response Rejection Reasons

This new feature paves the way for better error handling in the litep2p library and moves away from the overarching litep2p::error::Error enum.

The newly added ImmediateDialError enum captures errors occurring before a dial request is sent (e.g., missing peer IDs). It also enhances the RejectReason enum for request-response protocols, offering more detailed rejection reasons.

match error {
    RequestResponseError::Rejected(reason) => {
        match reason {
            RejectReason::ConnectionClosed => "connection-closed",
            RejectReason::DialFailed(Some(ImmediateDialError::AlreadyConnected)) => "already-connected",
            _ => "other",
        }
    }
    _ => "other",
}

Connection Limits

Developers can now set limits on the number of inbound and outbound connections to manage resources and optimize performance.

    // Configure connection limits for inbound and outbound established connections.
    let litep2p_config = Config::default()
        .with_connection_limits(ConnectionLimitsConfig::default()
            .max_incoming_connections(Some(3))
            .max_outgoing_connections(Some(2))
        );

Feature Flags for Optional Transports

The library now supports feature flags to selectively enable or disable transport protocols. By default, only the TCP transport is enabled. Optional transports include:

  • quic - Enables QUIC transport.
  • websocket - Enables WebSocket transport.
  • webrtc - Enables WebRTC transport.

Configurable Keep-Alive Timeout

The keep-alive timeout for connections is now configurable, providing more control over connection lifecycles.

    // Set keep alive timeout for connections.
    let litep2p_config = Config::default()
        .with_keep_alive_timeout(Duration::from_secs(30));

Thanks for contributing to this @Ma233!

Added

  • errors: Introduce immediate dial error and request-response rejection reasons (#227)
  • Expose API for PublicAddresses (#212)
  • transport: Implement TransportService::local_peer_id() (#224)
  • find_node: Optimize parallelism factor for slow to respond peers (#220)
  • kad: Handle ADD_PROVIDER & GET_PROVIDERS network requests (#213)
  • errors: Add DialError error and ListDialFailures event for better error reporting (#206)
  • kad: Add support for provider records to MemoryStore (#200)
  • transport: Add accept_pending/reject_pending for inbound connections and introduce inbound limits (#194)
  • transport/manager: Add connection limits for inbound and outbound established connections (#185)
  • kad: Add query id to log messages (#174)

Changed

  • transport: Replace trust_dns_resolver with hickory_resolver (#223)
  • crypto/noise: Generate keypair only for Curve25519 (#214)
  • transport: Allow manual setting of keep-alive timeout (#155)
  • kad: Update connection status of an existing bucket entry (#181)
  • Make transports optional (#192)

Fixed

  • kad: Fix substream opening and dialing race (#222)
  • query-executor: Save the task waker on empty futures (#219)
  • substream: Use write_all instead of manually writing bytes (#217)
  • minor: fix tests without websocket feature (#215)
  • Fix TCP, WebSocket, QUIC leaking connection IDs in reject() (#198)
  • transport: Fix double lock and state overwrite on disconnected peers (#179)
  • kad: Do not update memory store on incoming GetRecordSuccess (#190)
  • transport: Reject secondary connections with different connection IDs (#176)

[0.6.2] - 2024-06-26

This is a bug fixing release. Kademlia now correctly sets and forwards publisher & ttl in the DHT records.

Fixed

  • kademlia: Preserve publisher & expiration time in DHT records (#162)

[0.6.1] - 2024-06-20

This is a bug fixing and security release. curve255190-dalek has been upgraded to v4.1.3, see dalek-cryptography/curve25519-dalek#659 for details.

Fixed

  • kad: Set default ttl 36h for kad records (#154)
  • chore: update ed25519-dalek to v2.1.1 (#122)
  • Bump curve255190-dalek 4.1.2 -> 4.1.3 (#159)

[0.6.0] - 2024-06-14

This release introduces breaking changes into kad module. The API has been extended as following:

  • An event KademliaEvent::IncomingRecord has been added.
  • New methods KademliaHandle::store_record() / KademliaHandle::try_store_record() have been introduced.

This allows implementing manual incoming DHT record validation by configuring Kademlia with IncomingRecordValidationMode::Manual.

Also, it is now possible to enable TCP_NODELAY on sockets.

Multiple refactorings to remove the code duplications and improve the implementation robustness have been done.

Added

  • Support manual DHT record insertion (#135)
  • transport: Make TCP_NODELAY configurable (#146)

Changed

  • transport: Introduce common listener for tcp and websocket (#147)
  • transport/common: Share DNS lookups between TCP and WebSocket (#151)

Fixed

  • ping: Make ping fault tolerant wrt outbound substreams races (#133)
  • crypto/noise: Make noise fault tolerant (#142)
  • protocol/notif: Fix panic on missing peer state (#143)
  • transport: Fix erroneous handling of secondary connections (#149)

[0.5.0] - 2024-05-24

This is a small release that makes the FindNode command a bit more robust:

  • The FindNode command now retains the K (replication factor) best results.
  • The FindNode command has been updated to handle errors and unexpected states without panicking.

Added

  • Add release checklist (#115)

Changed

  • kad: Refactor FindNode query, keep K best results and add tests (#114)

[0.4.0] - 2024-05-23

This release introduces breaking changes to the litep2p crate, primarily affecting the kad module. Key updates include:

  • The GetRecord command now exposes all peer records, not just the latest one.
  • A new RecordType has been introduced to clearly distinguish between locally stored records and those discovered from the network.

Significant refactoring has been done to enhance the efficiency and accuracy of the kad module. The updates are as follows:

  • The GetRecord command now exposes all peer records.
  • The GetRecord command has been updated to handle errors and unexpected states without panicking.

Additionally, we've improved code coverage in the kad module by adding more tests.

Added

  • Re-export multihash & multiaddr types (#79)
  • kad: Expose all peer records of GET_VALUE query (#96)

Changed

  • multistream_select: Remove unneeded changelog.md (#116)
  • kad: Refactor GetRecord query and add tests (#97)
  • kad/store: Set memory-store on an incoming record for PutRecordTo (#88)
  • multistream: Dialer deny multiple /multistream/1.0.0 headers (#61)
  • kad: Limit MemoryStore entries (#78)
  • Refactor WebRTC code (#51)
  • Revert "Bring rustfmt.toml in sync with polkadot-sdk (#71)" (#74)
  • cargo: Update str0m from 0.4.1 to 0.5.1 (#95)

Fixed

  • Fix clippy (#83)
  • crypto: Don't panic on unsupported key types (#84)

[0.3.0] - 2024-04-05

Added

  • Expose reuse_port option for TCP and WebSocket transports (#69)
  • protocol/mdns: Use SO_REUSEPORT for the mDNS socket (#68)
  • Add support for protocol/agent version (#64)

[0.2.0] - 2023-09-05

This is the second release of litep2p, v0.2.0. The quality of the first release was so bad that this release is a complete rewrite of the library.

Support is added for the following features:

This time the architecture has been designed to be extensible and integrating new transport and/or user-level protocols should be easier. Additionally, the test coverage is higher both in terms of unit and integration tests. The project also contains conformance tests which test the behavior of litep2p against, rust-libp2p, go-libp2p and Substrate's sc-network. Currently the Substrate conformance tests are not enabled by default as they require unpublished/unaccepted changes to Substrate.

[0.1.0] - 2023-04-04

This is the first release of litep2p, v0.1.0.

Support is added for the following:

The code quality is atrocious but it works and the second release focuses on providing high test coverage for the library. After that is done and most of the functionality is covered (unit, integration and conformance tests, benchmarks), the focus can be turned to refactoring the code into something clean and efficient.