Skip to content

Latest commit

 

History

History
142 lines (91 loc) · 7.13 KB

CHANGELOG.md

File metadata and controls

142 lines (91 loc) · 7.13 KB

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.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.