libp2p 0.2.6__tar.gz → 0.2.8__tar.gz

{libp2p-0.2.6/libp2p.egg-info → libp2p-0.2.8}/PKG-INFO

@@ -1,29 +1,23 @@
 Metadata-Version: 2.4
 Name: libp2p
-Version: 0.2.6
+Version: 0.2.8
 Summary: libp2p: The Python implementation of the libp2p networking stack
-Home-page: https://github.com/libp2p/py-libp2p
-Author: The Ethereum Foundation
-Author-email: snakecharmers@ethereum.org
+Author-email: The Ethereum Foundation <snakecharmers@ethereum.org>
 License: MIT AND Apache-2.0
-Keywords: libp2p p2p
-Platform: unix
-Platform: linux
-Platform: osx
-Platform: win32
+Project-URL: Homepage, https://github.com/libp2p/py-libp2p
+Keywords: libp2p,p2p
 Classifier: Development Status :: 4 - Beta
 Classifier: Intended Audience :: Developers
 Classifier: Natural Language :: English
 Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
-Requires-Python: >=3.9, <4
+Requires-Python: <4.0,>=3.10
 Description-Content-Type: text/markdown
-License-File: LICENSE-MIT
 License-File: LICENSE-APACHE
+License-File: LICENSE-MIT
 Requires-Dist: base58>=1.0.3
 Requires-Dist: coincurve>=10.0.0
 Requires-Dist: exceptiongroup>=1.2.0; python_version < "3.11"
@@ -32,23 +26,24 @@ Requires-Dist: lru-dict>=1.1.6
 Requires-Dist: multiaddr>=0.0.9
 Requires-Dist: mypy-protobuf>=3.0.0
 Requires-Dist: noiseprotocol>=0.3.0
-Requires-Dist: protobuf>=6.30.1
+Requires-Dist: protobuf<4.0.0,>=3.20.1
 Requires-Dist: pycryptodome>=3.9.2
 Requires-Dist: pymultihash>=0.8.2
 Requires-Dist: pynacl>=1.3.0
 Requires-Dist: rpcudp>=3.0.0
 Requires-Dist: trio-typing>=0.0.4
 Requires-Dist: trio>=0.26.0
-Requires-Dist: fastecdsa==1.7.5
+Requires-Dist: fastecdsa==2.3.2; sys_platform != "win32"
 Provides-Extra: dev
 Requires-Dist: build>=0.9.0; extra == "dev"
 Requires-Dist: bump_my_version>=0.19.0; extra == "dev"
 Requires-Dist: ipython; extra == "dev"
-Requires-Dist: mypy==1.10.0; extra == "dev"
+Requires-Dist: mypy>=1.15.0; extra == "dev"
 Requires-Dist: pre-commit>=3.4.0; extra == "dev"
 Requires-Dist: tox>=4.0.0; extra == "dev"
 Requires-Dist: twine; extra == "dev"
 Requires-Dist: wheel; extra == "dev"
+Requires-Dist: setuptools>=42; extra == "dev"
 Requires-Dist: sphinx>=6.0.0; extra == "dev"
 Requires-Dist: sphinx_rtd_theme>=1.0.0; extra == "dev"
 Requires-Dist: towncrier<25,>=24; extra == "dev"
@@ -57,30 +52,20 @@ Requires-Dist: pytest>=7.0.0; extra == "dev"
 Requires-Dist: pytest-xdist>=2.4.0; extra == "dev"
 Requires-Dist: pytest-trio>=0.5.2; extra == "dev"
 Requires-Dist: factory-boy<3.0.0,>=2.12.0; extra == "dev"
+Requires-Dist: ruff>=0.11.10; extra == "dev"
+Requires-Dist: pyrefly<0.18.0,>=0.17.1; extra == "dev"
 Provides-Extra: docs
 Requires-Dist: sphinx>=6.0.0; extra == "docs"
 Requires-Dist: sphinx_rtd_theme>=1.0.0; extra == "docs"
 Requires-Dist: towncrier<25,>=24; extra == "docs"
+Requires-Dist: tomli; python_version < "3.11" and extra == "docs"
 Provides-Extra: test
 Requires-Dist: p2pclient==0.2.0; extra == "test"
 Requires-Dist: pytest>=7.0.0; extra == "test"
 Requires-Dist: pytest-xdist>=2.4.0; extra == "test"
 Requires-Dist: pytest-trio>=0.5.2; extra == "test"
 Requires-Dist: factory-boy<3.0.0,>=2.12.0; extra == "test"
-Dynamic: author
-Dynamic: author-email
-Dynamic: classifier
-Dynamic: description
-Dynamic: description-content-type
-Dynamic: home-page
-Dynamic: keywords
-Dynamic: license
 Dynamic: license-file
-Dynamic: platform
-Dynamic: provides-extra
-Dynamic: requires-dist
-Dynamic: requires-python
-Dynamic: summary
 
 # py-libp2p
 

libp2p-0.2.8/docs/conf.py

@@ -0,0 +1,349 @@
+# py-libp2p documentation build configuration file, created by
+# sphinx-quickstart on Thu Oct 16 20:43:24 2014.
+#
+# This file is execfile()d with the current directory set to its
+# containing dir.
+#
+# Note that not all possible configuration values are present in this
+# autogenerated file.
+#
+# All configuration values have a default; values that are commented out
+# serve to show the default.
+
+# If extensions (or modules to document with autodoc) are in another directory,
+# add these directories to sys.path here. If the directory is relative to the
+# documentation root, use os.path.abspath to make it absolute, like shown here.
+# sys.path.insert(0, os.path.abspath('.'))
+
+import doctest
+import os
+import sys
+from unittest.mock import MagicMock
+
+try:
+    import tomllib
+except ModuleNotFoundError:
+    # For Python < 3.11
+    import tomli as tomllib  # type: ignore (In case of >3.11 Pyrefly doesnt find tomli , which is right but a false flag)
+
+# Path to pyproject.toml (assuming conf.py is in a 'docs' subdirectory)
+pyproject_path = os.path.join(os.path.dirname(__file__), "..", "pyproject.toml")
+
+with open(pyproject_path, "rb") as f:
+    pyproject_data = tomllib.load(f)
+
+setup_version = pyproject_data["project"]["version"]
+
+# -- General configuration ------------------------------------------------
+
+# If your documentation needs a minimal Sphinx version, state it here.
+# needs_sphinx = '1.0'
+
+# Add any Sphinx extension module names here, as strings. They can be
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
+# ones.
+extensions = [
+    "sphinx.ext.autodoc",
+    "sphinx.ext.doctest",
+    "sphinx.ext.intersphinx",
+    "sphinx_rtd_theme",
+]
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ["_templates"]
+
+# The suffix of source filenames.
+source_suffix = ".rst"
+
+# The encoding of source files.
+# source_encoding = 'utf-8-sig'
+
+# The master toctree document.
+master_doc = "index"
+
+# General information about the project.
+project = "py-libp2p"
+copyright = "2019, The libp2p team"
+author = "The libp2p team"
+
+__version__ = setup_version
+# The version info for the project you're documenting, acts as replacement for
+# |version| and |release|, also used in various other places throughout the
+# built documents.
+#
+# The short X.Y version.
+version = ".".join(__version__.split(".")[:2])
+# The full version, including alpha/beta/rc tags.
+release = __version__
+
+# The language for content autogenerated by Sphinx. Refer to documentation
+# for a list of supported languages.
+# language = None
+
+# There are two options for replacing |today|: either, you set today to some
+# non-false value, then it is used:
+# today = ''
+# Else, today_fmt is used as the format for a strftime call.
+# today_fmt = '%B %d, %Y'
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+exclude_patterns = [
+    "_build",
+    "modules.rst",
+    "libp2p.crypto.pb.rst",
+]
+
+# The reST default role (used for this markup: `text`) to use for all
+# documents.
+# default_role = None
+
+# If true, '()' will be appended to :func: etc. cross-reference text.
+# add_function_parentheses = True
+
+# If true, the current module name will be prepended to all description
+# unit titles (such as .. function::).
+# add_module_names = True
+
+# If true, sectionauthor and moduleauthor directives will be shown in the
+# output. They are ignored by default.
+# show_authors = False
+
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = "sphinx"
+
+# A list of ignored prefixes for module index sorting.
+# modindex_common_prefix = []
+
+# If true, keep warnings as "system message" paragraphs in the built documents.
+# keep_warnings = False
+
+
+# -- Options for HTML output ----------------------------------------------
+
+# The theme to use for HTML and HTML Help pages.  See the documentation for
+# a list of builtin themes.
+html_theme = "sphinx_rtd_theme"
+
+# Theme options are theme-specific and customize the look and feel of a theme
+# further.  For a list of options available for each theme, see the
+# documentation.
+html_theme_options = {
+    "logo_only": True,
+    "version_selector": False,
+    "language_selector": False,
+}
+
+# Add any paths that contain custom themes here, relative to this directory.
+
+# The name for this set of Sphinx documents.  If None, it defaults to
+# "<project> v<release> documentation".
+# html_title = None
+
+# A shorter title for the navigation bar.  Default is the same as html_title.
+# html_short_title = None
+
+# The name of an image file (relative to this directory) to place at the top
+# of the sidebar.
+html_logo = "_static/py-libp2p-logo.png"
+
+# The name of an image file (within the static path) to use as favicon of the
+# docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
+# pixels large.
+# html_favicon = None
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+html_static_path = ["_static"]
+
+# Add any extra paths that contain custom files (such as robots.txt or
+# .htaccess) here, relative to this directory. These files are copied
+# directly to the root of the documentation.
+# html_extra_path = []
+
+# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
+# using the given strftime format.
+# html_last_updated_fmt = '%b %d, %Y'
+
+# If true, SmartyPants will be used to convert quotes and dashes to
+# typographically correct entities.
+# html_use_smartypants = True
+
+# Custom sidebar templates, maps document names to template names.
+# html_sidebars = {}
+
+# Additional templates that should be rendered to pages, maps page names to
+# template names.
+# html_additional_pages = {}
+
+# If false, no module index is generated.
+# html_domain_indices = True
+
+# If false, no index is generated.
+# html_use_index = True
+
+# If true, the index is split into individual pages for each letter.
+# html_split_index = False
+
+# If true, links to the reST sources are added to the pages.
+# html_show_sourcelink = True
+
+# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
+# html_show_sphinx = True
+
+# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
+# html_show_copyright = True
+
+# If true, an OpenSearch description file will be output, and all pages will
+# contain a <link> tag referring to it.  The value of this option must be the
+# base URL from which the finished HTML is served.
+# html_use_opensearch = ''
+
+# This is the file name suffix for HTML files (e.g. ".xhtml").
+# html_file_suffix = None
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = "libp2pdocs"
+
+
+# -- Options for LaTeX output ---------------------------------------------
+
+latex_engine = "xelatex"
+
+latex_elements = {
+    # The paper size ('letterpaper' or 'a4paper').
+    #'papersize': 'letterpaper',
+    # The font size ('10pt', '11pt' or '12pt').
+    #'pointsize': '10pt',
+    # Additional stuff for the LaTeX preamble.
+    #'preamble': '',
+}
+
+# Grouping the document tree into LaTeX files. List of tuples
+# (source start file, target name, title,
+#  author, documentclass [howto, manual, or own class]).
+latex_documents = [
+    (
+        "index",
+        "libp2p.tex",
+        "py-libp2p Documentation",
+        "The Ethereum Foundation",
+        "manual",
+    ),
+]
+
+# The name of an image file (relative to this directory) to place at the top of
+# the title page.
+# latex_logo = None
+
+# For "manual" documents, if this is true, then toplevel headings are parts,
+# not chapters.
+# latex_use_parts = False
+
+# If true, show page references after internal links.
+# latex_show_pagerefs = False
+
+# If true, show URL addresses after external links.
+# latex_show_urls = False
+
+# Documents to append as an appendix to all manuals.
+# latex_appendices = []
+
+# If false, no module index is generated.
+# latex_domain_indices = True
+
+
+# -- Options for manual page output ---------------------------------------
+
+# One entry per manual page. List of tuples
+# (source start file, name, description, authors, manual section).
+man_pages = [
+    (
+        "index",
+        "libp2p",
+        "py-libp2p Documentation",
+        ["The Ethereum Foundation"],
+        1,
+    )
+]
+
+# If true, show URL addresses after external links.
+# man_show_urls = False
+
+
+# -- Options for Texinfo output -------------------------------------------
+
+# Grouping the document tree into Texinfo files. List of tuples
+# (source start file, target name, title, author,
+#  dir menu entry, description, category)
+texinfo_documents = [
+    (
+        "index",
+        "py-libp2p",
+        "py-libp2p Documentation",
+        "The Ethereum Foundation",
+        "py-libp2p",
+        "The Python implementation of the libp2p networking stack",
+        "Miscellaneous",
+    ),
+]
+
+# Prevent autodoc from trying to import module from tests.factories
+autodoc_mock_imports = ["tests.factories"]
+
+# Documents to append as an appendix to all manuals.
+# texinfo_appendices = []
+
+# If false, no module index is generated.
+# texinfo_domain_indices = True
+
+# How to display URL addresses: 'footnote', 'no', or 'inline'.
+# texinfo_show_urls = 'footnote'
+
+# If true, do not generate a @detailmenu in the "Top" node's menu.
+# texinfo_no_detailmenu = False
+
+# -- Intersphinx configuration ------------------------------------------------
+
+intersphinx_mapping = {
+    "python": ("https://docs.python.org/3.10", None),
+}
+
+# -- Doctest configuration ----------------------------------------
+
+
+doctest_default_flags = (
+    0
+    | doctest.DONT_ACCEPT_TRUE_FOR_1
+    | doctest.ELLIPSIS
+    | doctest.IGNORE_EXCEPTION_DETAIL
+    | doctest.NORMALIZE_WHITESPACE
+)
+
+# -- Mocked dependencies ----------------------------------------
+
+# Mock out dependencies that are unbuildable on readthedocs, as recommended here:
+# https://docs.readthedocs.io/en/rel/faq.html#i-get-import-errors-on-libraries-that-depend-on-c-modules
+
+
+# Add new modules to mock here (it should be the same list
+# as those excluded in pyproject.toml)
+MOCK_MODULES = [
+    "fastecdsa",
+    "fastecdsa.encoding",
+    "fastecdsa.encoding.sec1",
+]
+sys.modules.update((mod_name, MagicMock()) for mod_name in MOCK_MODULES)
+# -- Extension configuration -------------------------------------------------
+
+# -- Options for todo extension ----------------------------------------------
+
+# If true, `todo` and `todoList` produce output, else they produce nothing.
+todo_include_todos = True
+
+# -- Options for autodoc extension ------------------------------------------
+
+# Allow duplicate object descriptions
+nitpicky = False
+nitpick_ignore = [("py:class", "type")]

{libp2p-0.2.6 → libp2p-0.2.8}/examples/chat/chat.py

@@ -40,7 +40,6 @@ async def write_data(stream: INetStream) -> None:
 
 
 async def run(port: int, destination: str) -> None:
-    localhost_ip = "127.0.0.1"
     listen_addr = multiaddr.Multiaddr(f"/ip4/0.0.0.0/tcp/{port}")
     host = new_host()
     async with host.run(listen_addrs=[listen_addr]), trio.open_nursery() as nursery:
@@ -54,8 +53,8 @@ async def run(port: int, destination: str) -> None:
 
             print(
                 "Run this from the same folder in another console:\n\n"
-                f"chat-demo -p {int(port) + 1} "
-                f"-d /ip4/{localhost_ip}/tcp/{port}/p2p/{host.get_id().pretty()}\n"
+                f"chat-demo "
+                f"-d {host.get_addrs()[0]}\n"
             )
             print("Waiting for incoming connection...")
 
@@ -87,9 +86,7 @@ def main() -> None:
         "/ip4/127.0.0.1/tcp/8000/p2p/QmQn4SwGkDZKkUEpBRBvTmheQycxAHJUNmVEnjA2v1qe8Q"
     )
     parser = argparse.ArgumentParser(description=description)
-    parser.add_argument(
-        "-p", "--port", default=8000, type=int, help="source port number"
-    )
+    parser.add_argument("-p", "--port", default=0, type=int, help="source port number")
     parser.add_argument(
         "-d",
         "--destination",
@@ -98,9 +95,6 @@ def main() -> None:
     )
     args = parser.parse_args()
 
-    if not args.port:
-        raise RuntimeError("was not able to determine a local port")
-
     try:
         trio.run(run, *(args.port, args.destination))
     except KeyboardInterrupt:

libp2p-0.2.8/examples/doc-examples/example_encryption_insecure.py

@@ -0,0 +1,51 @@
+import secrets
+
+import multiaddr
+import trio
+
+from libp2p import (
+    new_host,
+)
+from libp2p.crypto.secp256k1 import (
+    create_new_key_pair,
+)
+from libp2p.security.insecure.transport import (
+    PLAINTEXT_PROTOCOL_ID,
+    InsecureTransport,
+)
+
+
+async def main():
+    # Create a key pair for the host
+    secret = secrets.token_bytes(32)
+    key_pair = create_new_key_pair(secret)
+
+    # Create an insecure transport (not recommended for production)
+    insecure_transport = InsecureTransport(
+        # local_key_pair: The key pair used for libp2p identity
+        local_key_pair=key_pair,
+    )
+
+    # Create a security options dictionary mapping protocol ID to transport
+    security_options = {PLAINTEXT_PROTOCOL_ID: insecure_transport}
+
+    # Create a host with the key pair and insecure transport
+    host = new_host(key_pair=key_pair, sec_opt=security_options)
+
+    # Configure the listening address
+    port = 8000
+    listen_addr = multiaddr.Multiaddr(f"/ip4/0.0.0.0/tcp/{port}")
+
+    # Start the host
+    async with host.run(listen_addrs=[listen_addr]):
+        print(
+            "libp2p has started with insecure transport "
+            "(not recommended for production)"
+        )
+        print("libp2p is listening on:", host.get_addrs())
+        # Keep the host running
+        await trio.sleep_forever()
+
+
+# Run the async function
+trio.run(main)

libp2p-0.2.8/examples/doc-examples/example_encryption_noise.py

@@ -0,0 +1,55 @@
+import secrets
+
+import multiaddr
+import trio
+
+from libp2p import (
+    new_host,
+)
+from libp2p.crypto.secp256k1 import (
+    create_new_key_pair,
+)
+from libp2p.security.noise.transport import (
+    PROTOCOL_ID as NOISE_PROTOCOL_ID,
+    Transport as NoiseTransport,
+)
+
+
+async def main():
+    # Create a key pair for the host
+    secret = secrets.token_bytes(32)
+    key_pair = create_new_key_pair(secret)
+
+    # Create a Noise security transport
+    noise_transport = NoiseTransport(
+        # local_key_pair: The key pair used for libp2p identity and authentication
+        libp2p_keypair=key_pair,
+        # noise_privkey: The private key used for Noise protocol encryption
+        noise_privkey=key_pair.private_key,
+        # early_data: Optional data to send during the handshake
+        # (None means no early data)
+        early_data=None,
+        # with_noise_pipes: Whether to use Noise pipes for additional security features
+        with_noise_pipes=False,
+    )
+
+    # Create a security options dictionary mapping protocol ID to transport
+    security_options = {NOISE_PROTOCOL_ID: noise_transport}
+
+    # Create a host with the key pair and Noise security
+    host = new_host(key_pair=key_pair, sec_opt=security_options)
+
+    # Configure the listening address
+    port = 8000
+    listen_addr = multiaddr.Multiaddr(f"/ip4/0.0.0.0/tcp/{port}")
+
+    # Start the host
+    async with host.run(listen_addrs=[listen_addr]):
+        print("libp2p has started with Noise encryption")
+        print("libp2p is listening on:", host.get_addrs())
+        # Keep the host running
+        await trio.sleep_forever()
+
+
+# Run the async function
+trio.run(main)

libp2p-0.2.8/examples/doc-examples/example_encryption_secio.py

@@ -0,0 +1,48 @@
+import secrets
+
+import multiaddr
+import trio
+
+from libp2p import (
+    new_host,
+)
+from libp2p.crypto.secp256k1 import (
+    create_new_key_pair,
+)
+from libp2p.security.secio.transport import (
+    ID as SECIO_PROTOCOL_ID,
+    Transport as SecioTransport,
+)
+
+
+async def main():
+    # Create a key pair for the host
+    secret = secrets.token_bytes(32)
+    key_pair = create_new_key_pair(secret)
+
+    # Create a SECIO security transport
+    secio_transport = SecioTransport(
+        # local_key_pair: The key pair used for libp2p identity and authentication
+        local_key_pair=key_pair,
+    )
+
+    # Create a security options dictionary mapping protocol ID to transport
+    security_options = {SECIO_PROTOCOL_ID: secio_transport}
+
+    # Create a host with the key pair and SECIO security
+    host = new_host(key_pair=key_pair, sec_opt=security_options)
+
+    # Configure the listening address
+    port = 8000
+    listen_addr = multiaddr.Multiaddr(f"/ip4/0.0.0.0/tcp/{port}")
+
+    # Start the host
+    async with host.run(listen_addrs=[listen_addr]):
+        print("libp2p has started with SECIO encryption")
+        print("libp2p is listening on:", host.get_addrs())
+        # Keep the host running
+        await trio.sleep_forever()
+
+
+# Run the async function
+trio.run(main)

libp2p-0.2.8/examples/doc-examples/example_multiplexer.py

@@ -0,0 +1,55 @@
+import secrets
+
+import multiaddr
+import trio
+
+from libp2p import (
+    new_host,
+)
+from libp2p.crypto.secp256k1 import (
+    create_new_key_pair,
+)
+from libp2p.security.noise.transport import (
+    PROTOCOL_ID as NOISE_PROTOCOL_ID,
+    Transport as NoiseTransport,
+)
+
+
+async def main():
+    # Create a key pair for the host
+    secret = secrets.token_bytes(32)
+    key_pair = create_new_key_pair(secret)
+
+    # Create a Noise security transport
+    noise_transport = NoiseTransport(
+        # local_key_pair: The key pair used for libp2p identity and authentication
+        libp2p_keypair=key_pair,
+        # noise_privkey: The private key used for Noise protocol encryption
+        noise_privkey=key_pair.private_key,
+        # early_data: Optional data to send during the handshake
+        # (None means no early data)
+        early_data=None,
+        # with_noise_pipes: Whether to use Noise pipes for additional security features
+        with_noise_pipes=False,
+    )
+
+    # Create a security options dictionary mapping protocol ID to transport
+    security_options = {NOISE_PROTOCOL_ID: noise_transport}
+
+    # Create a host with the key pair, Noise security, and mplex multiplexer
+    host = new_host(key_pair=key_pair, sec_opt=security_options)
+
+    # Configure the listening address
+    port = 8000
+    listen_addr = multiaddr.Multiaddr(f"/ip4/0.0.0.0/tcp/{port}")
+
+    # Start the host
+    async with host.run(listen_addrs=[listen_addr]):
+        print("libp2p has started with Noise encryption and mplex multiplexing")
+        print("libp2p is listening on:", host.get_addrs())
+        # Keep the host running
+        await trio.sleep_forever()
+
+
+# Run the async function
+trio.run(main)