From f9b8ac9da19ecf14ba4993666b0957ae80b5d514 Mon Sep 17 00:00:00 2001 From: pacrob <5199899+pacrob@users.noreply.github.com> Date: Thu, 27 Mar 2025 14:46:44 -0600 Subject: [PATCH] Compile release notes for v0.2.3 --- docs/release_notes.rst | 38 ++++++++++++++++++++++++++++++++++ newsfragments/228.internal.rst | 1 - newsfragments/358.feature.rst | 1 - newsfragments/420.feature.rst | 1 - newsfragments/498.docs.rst | 1 - newsfragments/503.internal.rst | 1 - newsfragments/513.bugfix.rst | 1 - newsfragments/518.feature.rst | 1 - newsfragments/522.internal.rst | 1 - newsfragments/523.feature.rst | 2 -- newsfragments/524.feature.rst | 1 - newsfragments/535.docs.rst | 1 - newsfragments/536.feature.rst | 1 - newsfragments/542.internal.rst | 1 - newsfragments/543.internal.rst | 1 - 15 files changed, 38 insertions(+), 15 deletions(-) delete mode 100644 newsfragments/228.internal.rst delete mode 100644 newsfragments/358.feature.rst delete mode 100644 newsfragments/420.feature.rst delete mode 100644 newsfragments/498.docs.rst delete mode 100644 newsfragments/503.internal.rst delete mode 100644 newsfragments/513.bugfix.rst delete mode 100644 newsfragments/518.feature.rst delete mode 100644 newsfragments/522.internal.rst delete mode 100644 newsfragments/523.feature.rst delete mode 100644 newsfragments/524.feature.rst delete mode 100644 newsfragments/535.docs.rst delete mode 100644 newsfragments/536.feature.rst delete mode 100644 newsfragments/542.internal.rst delete mode 100644 newsfragments/543.internal.rst diff --git a/docs/release_notes.rst b/docs/release_notes.rst index 17515b8a..a37b3cd7 100644 --- a/docs/release_notes.rst +++ b/docs/release_notes.rst @@ -3,6 +3,44 @@ Release Notes .. towncrier release notes start +py-libp2p v0.2.3 (2025-03-27) +----------------------------- + +Bugfixes +~~~~~~~~ + +- Fixed import path in the examples to use updated `net_stream` module path, resolving ModuleNotFoundError when running the examples. (`#513 `__) + + +Improved Documentation +~~~~~~~~~~~~~~~~~~~~~~ + +- Updates ``Feature Breakdown`` in ``README`` to more closely match the list of standard modules. (`#498 `__) +- Adds detailed Sphinx-style docstrings to ``abc.py``. (`#535 `__) + + +Features +~~~~~~~~ + +- Improved the implementation of the identify protocol and enhanced test coverage to ensure proper functionality and network layer address delegation. (`#358 `__) +- Adds the ability to check connection status of a peer in the peerstore. (`#420 `__) +- implemented ``timed_cache`` module which will allow to implement ``seen_ttl`` configurable param for pubsub and protocols extending it. (`#518 `__) +- Added a maximum RSA key size limit of 4096 bits to prevent resource exhaustion attacks.Consolidated validation logic to use a single error message source and + added tests to catch invalid key sizes (including negative values). (`#523 `__) +- Added automated testing of ``demo`` applications as part of CI to prevent demos from breaking silently. Tests are located in `tests/core/examples/test_examples.py`. (`#524 `__) +- Added an example implementation of the identify protocol to demonstrate its usage and help users understand how to properly integrate it into their libp2p applications. (`#536 `__) + + +Internal Changes - for py-libp2p Contributors +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +- moved all interfaces to ``libp2p.abc`` along with all libp2p custom types to ``libp2p.custom_types``. (`#228 `__) +- moved ``libp2p/tools/factories`` to ``tests``. (`#503 `__) +- Fixes broken CI lint run, bumps ``pre-commit-hooks`` version to ``5.0.0`` and ``mdformat`` to ``0.7.22``. (`#522 `__) +- Rebuilds protobufs with ``protoc v30.1``. (`#542 `__) +- Moves ``pubsub`` testing tools from ``libp2p.tools`` and ``factories`` from ``tests`` to ``tests.utils``. (`#543 `__) + + py-libp2p v0.2.2 (2025-02-20) ----------------------------- diff --git a/newsfragments/228.internal.rst b/newsfragments/228.internal.rst deleted file mode 100644 index 6e9badb6..00000000 --- a/newsfragments/228.internal.rst +++ /dev/null @@ -1 +0,0 @@ -moved all interfaces to ``libp2p.abc`` along with all libp2p custom types to ``libp2p.custom_types``. diff --git a/newsfragments/358.feature.rst b/newsfragments/358.feature.rst deleted file mode 100644 index e17d467e..00000000 --- a/newsfragments/358.feature.rst +++ /dev/null @@ -1 +0,0 @@ -Improved the implementation of the identify protocol and enhanced test coverage to ensure proper functionality and network layer address delegation. diff --git a/newsfragments/420.feature.rst b/newsfragments/420.feature.rst deleted file mode 100644 index 92987871..00000000 --- a/newsfragments/420.feature.rst +++ /dev/null @@ -1 +0,0 @@ -Adds the ability to check connection status of a peer in the peerstore. diff --git a/newsfragments/498.docs.rst b/newsfragments/498.docs.rst deleted file mode 100644 index 472adea8..00000000 --- a/newsfragments/498.docs.rst +++ /dev/null @@ -1 +0,0 @@ -Updates ``Feature Breakdown`` in ``README`` to more closely match the list of standard modules. diff --git a/newsfragments/503.internal.rst b/newsfragments/503.internal.rst deleted file mode 100644 index c991d16b..00000000 --- a/newsfragments/503.internal.rst +++ /dev/null @@ -1 +0,0 @@ -moved ``libp2p/tools/factories`` to ``tests``. diff --git a/newsfragments/513.bugfix.rst b/newsfragments/513.bugfix.rst deleted file mode 100644 index 404eee93..00000000 --- a/newsfragments/513.bugfix.rst +++ /dev/null @@ -1 +0,0 @@ -Fixed import path in the examples to use updated `net_stream` module path, resolving ModuleNotFoundError when running the examples. diff --git a/newsfragments/518.feature.rst b/newsfragments/518.feature.rst deleted file mode 100644 index 28d41854..00000000 --- a/newsfragments/518.feature.rst +++ /dev/null @@ -1 +0,0 @@ -implemented ``timed_cache`` module which will allow to implement ``seen_ttl`` configurable param for pubsub and protocols extending it. diff --git a/newsfragments/522.internal.rst b/newsfragments/522.internal.rst deleted file mode 100644 index 3ec35f80..00000000 --- a/newsfragments/522.internal.rst +++ /dev/null @@ -1 +0,0 @@ -Fixes broken CI lint run, bumps ``pre-commit-hooks`` version to ``5.0.0`` and ``mdformat`` to ``0.7.22``. diff --git a/newsfragments/523.feature.rst b/newsfragments/523.feature.rst deleted file mode 100644 index 62593a65..00000000 --- a/newsfragments/523.feature.rst +++ /dev/null @@ -1,2 +0,0 @@ -Added a maximum RSA key size limit of 4096 bits to prevent resource exhaustion attacks.Consolidated validation logic to use a single error message source and -added tests to catch invalid key sizes (including negative values). diff --git a/newsfragments/524.feature.rst b/newsfragments/524.feature.rst deleted file mode 100644 index 910341be..00000000 --- a/newsfragments/524.feature.rst +++ /dev/null @@ -1 +0,0 @@ -Added automated testing of ``demo`` applications as part of CI to prevent demos from breaking silently. Tests are located in `tests/core/examples/test_examples.py`. diff --git a/newsfragments/535.docs.rst b/newsfragments/535.docs.rst deleted file mode 100644 index 6fcf3f50..00000000 --- a/newsfragments/535.docs.rst +++ /dev/null @@ -1 +0,0 @@ -Adds detailed Sphinx-style docstrings to ``abc.py``. diff --git a/newsfragments/536.feature.rst b/newsfragments/536.feature.rst deleted file mode 100644 index 247de065..00000000 --- a/newsfragments/536.feature.rst +++ /dev/null @@ -1 +0,0 @@ -Added an example implementation of the identify protocol to demonstrate its usage and help users understand how to properly integrate it into their libp2p applications. diff --git a/newsfragments/542.internal.rst b/newsfragments/542.internal.rst deleted file mode 100644 index df876ad8..00000000 --- a/newsfragments/542.internal.rst +++ /dev/null @@ -1 +0,0 @@ -Rebuilds protobufs with ``protoc v30.1``. diff --git a/newsfragments/543.internal.rst b/newsfragments/543.internal.rst deleted file mode 100644 index af1ebb80..00000000 --- a/newsfragments/543.internal.rst +++ /dev/null @@ -1 +0,0 @@ -Moves ``pubsub`` testing tools from ``libp2p.tools`` and ``factories`` from ``tests`` to ``tests.utils``.