mirror of
https://github.com/varun-r-mallya/py-libp2p.git
synced 2025-12-31 20:36:24 +00:00
* feat: Replace mplex with yamux as default multiplexer in py-libp2p * Retain Mplex alongside Yamux in new_swarm with messaging that Yamux is preferred * moved !BBHII to a constant YAMUX_HEADER_FORMAT at the top of yamux.py with a comment explaining its structure * renamed the news fragment to 534.feature.rst and updated the description * renamed the news fragment to 534.feature.rst and updated the description * added a docstring to clarify that Yamux does not support deadlines natively * Remove the __main__ block entirely from test_yamux.py * Replaced the print statements in test_yamux.py with logging.debug * Added a comment linking to the spec for clarity * Raise NotImplementedError in YamuxStream.set_deadline per review * Add muxed_conn to YamuxStream and test deadline NotImplementedError * Fix Yamux implementation to meet libp2p spec * Fix None handling in YamuxStream.read and Yamux.read_stream * Fix test_connected_peers.py to correctly handle peer connections * fix: Ensure StreamReset is raised on read after local reset in yamux * fix: Map MuxedStreamError to StreamClosed in NetStream.write for Yamux * fix: Raise MuxedStreamReset in Yamux.read_stream for closed streams * fix: Correct Yamux stream read behavior for NetStream tests Fixed est_net_stream_read_after_remote_closed by updating NetStream.read to raise StreamEOF when the stream is remotely closed and no data is available, aligning with test expectations and Fixed est_net_stream_read_until_eof by modifying YamuxStream.read to block until the stream is closed ( ecv_closed=True) for =-1 reads, ensuring data is only returned after remote closure. * fix: Correct Yamux stream read behavior for NetStream tests Fixed est_net_stream_read_after_remote_closed by updating NetStream.read to raise StreamEOF when the stream is remotely closed and no data is available, aligning with test expectations and Fixed est_net_stream_read_until_eof by modifying YamuxStream.read to block until the stream is closed ( ecv_closed=True) for =-1 reads, ensuring data is only returned after remote closure. * fix: raise StreamEOF when reading from closed stream with empty buffer * fix: prioritize returning buffered data even after stream reset * fix: prioritize returning buffered data even after stream reset * fix: Ensure test_net_stream_read_after_remote_closed_and_reset passes in full suite * fix: Add __init__.py to yamux module to fix documentation build * fix: Add __init__.py to yamux module to fix documentation build * fix: Add libp2p.stream_muxer.yamux to libp2p.stream_muxer.rst toctree * fix: Correct title underline length in libp2p.stream_muxer.yamux.rst * fix: Add a = so that is matches the libp2p.stream\_muxer.yamux length * fix(tests): Resolve race condition in network notification test * fix: fixing failing tests and examples with yamux and noise * refactor: remove debug logging and improve x25519 tests * fix: Add functionality for users to choose between Yamux and Mplex * fix: increased trio sleep to 0.1 sec for slow environment * feat: Add test for switching between Yamux and mplex * refactor: move host fixtures to interop tests * chore: Update __init__.py removing unused import removed unused ```python import os import logging ``` * lint: fix import order * fix: Resolve conftest.py conflict by removing trio test support * fix: Resolve test skipping by keeping trio test support * Fix: add a newline at end of the file --------- Co-authored-by: acul71 <luca.pisani@birdo.net> Co-authored-by: acul71 <34693171+acul71@users.noreply.github.com>
164 lines
5.2 KiB
Python
164 lines
5.2 KiB
Python
#!/usr/bin/env python3
|
|
"""
|
|
Example demonstrating the identify/push protocol.
|
|
|
|
This example shows how to:
|
|
1. Set up a host with the identify/push protocol handler
|
|
2. Connect to another peer
|
|
3. Push identify information to the peer
|
|
4. Receive and process identify/push messages
|
|
"""
|
|
|
|
import logging
|
|
|
|
import trio
|
|
|
|
from libp2p import (
|
|
new_host,
|
|
)
|
|
from libp2p.crypto.secp256k1 import (
|
|
create_new_key_pair,
|
|
)
|
|
from libp2p.custom_types import (
|
|
TProtocol,
|
|
)
|
|
from libp2p.identity.identify import (
|
|
identify_handler_for,
|
|
)
|
|
from libp2p.identity.identify_push import (
|
|
ID_PUSH,
|
|
identify_push_handler_for,
|
|
push_identify_to_peer,
|
|
)
|
|
from libp2p.peer.peerinfo import (
|
|
info_from_p2p_addr,
|
|
)
|
|
|
|
# Configure logging
|
|
logger = logging.getLogger(__name__)
|
|
|
|
|
|
async def main() -> None:
|
|
print("\n==== Starting Identify-Push Example ====\n")
|
|
|
|
# Create key pairs for the two hosts
|
|
key_pair_1 = create_new_key_pair()
|
|
key_pair_2 = create_new_key_pair()
|
|
|
|
# Create the first host
|
|
host_1 = new_host(key_pair=key_pair_1)
|
|
|
|
# Set up the identify and identify/push handlers
|
|
host_1.set_stream_handler(TProtocol("/ipfs/id/1.0.0"), identify_handler_for(host_1))
|
|
host_1.set_stream_handler(ID_PUSH, identify_push_handler_for(host_1))
|
|
|
|
# Create the second host
|
|
host_2 = new_host(key_pair=key_pair_2)
|
|
|
|
# Set up the identify and identify/push handlers
|
|
host_2.set_stream_handler(TProtocol("/ipfs/id/1.0.0"), identify_handler_for(host_2))
|
|
host_2.set_stream_handler(ID_PUSH, identify_push_handler_for(host_2))
|
|
|
|
# Start listening on random ports using the run context manager
|
|
import multiaddr
|
|
|
|
listen_addr_1 = multiaddr.Multiaddr("/ip4/127.0.0.1/tcp/0")
|
|
listen_addr_2 = multiaddr.Multiaddr("/ip4/127.0.0.1/tcp/0")
|
|
|
|
async with host_1.run([listen_addr_1]), host_2.run([listen_addr_2]):
|
|
# Get the addresses of both hosts
|
|
addr_1 = host_1.get_addrs()[0]
|
|
logger.info(f"Host 1 listening on {addr_1}")
|
|
print(f"Host 1 listening on {addr_1}")
|
|
print(f"Peer ID: {host_1.get_id().pretty()}")
|
|
|
|
addr_2 = host_2.get_addrs()[0]
|
|
logger.info(f"Host 2 listening on {addr_2}")
|
|
print(f"Host 2 listening on {addr_2}")
|
|
print(f"Peer ID: {host_2.get_id().pretty()}")
|
|
|
|
print("\nConnecting Host 2 to Host 1...")
|
|
|
|
# Connect host_2 to host_1
|
|
peer_info = info_from_p2p_addr(addr_1)
|
|
await host_2.connect(peer_info)
|
|
logger.info("Host 2 connected to Host 1")
|
|
print("Host 2 successfully connected to Host 1")
|
|
|
|
# Run the identify protocol from host_2 to host_1
|
|
# (so Host 1 learns Host 2's address)
|
|
from libp2p.identity.identify.identify import ID as IDENTIFY_PROTOCOL_ID
|
|
|
|
stream = await host_2.new_stream(host_1.get_id(), (IDENTIFY_PROTOCOL_ID,))
|
|
response = await stream.read()
|
|
await stream.close()
|
|
|
|
# Run the identify protocol from host_1 to host_2
|
|
# (so Host 2 learns Host 1's address)
|
|
stream = await host_1.new_stream(host_2.get_id(), (IDENTIFY_PROTOCOL_ID,))
|
|
response = await stream.read()
|
|
await stream.close()
|
|
|
|
# --- NEW CODE: Update Host 1's peerstore with Host 2's addresses ---
|
|
from libp2p.identity.identify.pb.identify_pb2 import (
|
|
Identify,
|
|
)
|
|
|
|
identify_msg = Identify()
|
|
identify_msg.ParseFromString(response)
|
|
peerstore_1 = host_1.get_peerstore()
|
|
peer_id_2 = host_2.get_id()
|
|
for addr_bytes in identify_msg.listen_addrs:
|
|
maddr = multiaddr.Multiaddr(addr_bytes)
|
|
# TTL can be any positive int
|
|
peerstore_1.add_addr(
|
|
peer_id_2,
|
|
maddr,
|
|
ttl=3600,
|
|
)
|
|
# --- END NEW CODE ---
|
|
|
|
# Now Host 1's peerstore should have Host 2's address
|
|
peerstore_1 = host_1.get_peerstore()
|
|
peer_id_2 = host_2.get_id()
|
|
addrs_1_for_2 = peerstore_1.addrs(peer_id_2)
|
|
logger.info(
|
|
f"[DEBUG] Host 1 peerstore addresses for Host 2 before push: "
|
|
f"{addrs_1_for_2}"
|
|
)
|
|
print(
|
|
f"[DEBUG] Host 1 peerstore addresses for Host 2 before push: "
|
|
f"{addrs_1_for_2}"
|
|
)
|
|
|
|
# Push identify information from host_1 to host_2
|
|
logger.info("Host 1 pushing identify information to Host 2")
|
|
print("\nHost 1 pushing identify information to Host 2...")
|
|
|
|
try:
|
|
# Call push_identify_to_peer which now returns a boolean
|
|
success = await push_identify_to_peer(host_1, host_2.get_id())
|
|
|
|
if success:
|
|
logger.info("Identify push completed successfully")
|
|
print("Identify push completed successfully!")
|
|
else:
|
|
logger.warning("Identify push didn't complete successfully")
|
|
print("\nWarning: Identify push didn't complete successfully")
|
|
|
|
except Exception as e:
|
|
logger.error(f"Error during identify push: {str(e)}")
|
|
print(f"\nError during identify push: {str(e)}")
|
|
|
|
# Add this at the end of your async with block:
|
|
await trio.sleep(0.5) # Give background tasks time to finish
|
|
|
|
|
|
if __name__ == "__main__":
|
|
trio.run(main)
|
|
|
|
|
|
def run_main():
|
|
"""Non-async entry point for the console script."""
|
|
trio.run(main)
|