Minimum Viable Product (MVP) Goals for Hole Punching Interop Test suite for py-libp2p

[seetadev]

Minimum Viable Product (MVP) Goals for Hole Punching Interop Test suite for py-libp2p

These are the core goals required to verify that py-libp2p's hole punching capability works and is interoperable with other libp2p implementations.

1. Relay-Aware Peer Discovery & Setup

• Connect to a known go-libp2p or js-libp2p relay node with /p2p-circuit v2 support.

• Enable a py-libp2p peer to act as both:

  • Initiator (starts the punch),
  • Receiver (responds to incoming punch).

2. Protocol Compliance

• Implement support for relay v2 and basic DCUtR flow.
• Exchange observed addresses over relayed connection.
• Trigger hole punching with timed simultaneous dials.
• Fallback to relayed connection on failure.

3. Cross-Implementation Compatibility

• Validate hole punching between py-libp2p and:

  • go-libp2p
  • js-libp2p

• Handle timing and protocol differences gracefully.

4. Test Suite Capabilities

• Build a basic Python-based test suite.

• Use Docker or subprocess to simulate:

  • Peers (initiator + receiver)
  • Relay node

• Include NAT simulation using basic network isolation or tools like iptables.

5. Connection Verification

• Assert that successful hole punching results in:

  • A direct connection.
  • Proper stream/muxer/security state post-upgrade.

6. Observability and Logging

• Log:

  • Address exchange
  • Dial attempts
  • Upgrade events
  • Failures and fallbacks

Extended Goals (Post-MVP)

These enhancements will improve usability, reliability, and adoption of the test suite.

1. Full Protocol Compliance

• Follow Hole Punching test plans repo and its spec/ go-implementation in detail, including:

  • Delayed dial windows
  • NAT-specific fallback logic
  • Error propagation rules

2. Broader Interop Coverage

• Add interop tests with:

  • nim-libp2p
  • dotnet-libp2p
  • zig-libp2p
  • rust-libp2p

• Self-interop between multiple py-libp2p nodes.

3. Advanced NAT Simulation

• Use pumba, netns, or similar to simulate:

  • Symmetric NATs
  • Restricted cone NATs
  • Full cone NATs

4. Enhanced Test Reporting

• Produce:

  • Test summary reports
  • Timing breakdowns
  • Connection topologies (before/after punching)

5. CI & Automation

• Integrate with GitHub Actions or similar.
• Trigger interop tests via labels, PRs, or nightly builds.
• Include stable Docker images for supported libp2p implementations.

6. Framework & Reusability

• Build reusable test harness.
• Add configuration files for topologies and implementation versions.
• Allow community contributors to plug in their own libp2p peers.