maidsafe-archive / crust

Reliable p2p network connections in Rust with NAT traversal. One of the most needed libraries for any server-less / decentralised projects
BSD 3-Clause "New" or "Revised" License
956 stars 126 forks source link

Exhaustively Document the nat traversal techniques used. #1156

Open fresheneesz opened 5 years ago

fresheneesz commented 5 years ago

The docs currently say: "Crust implements several NAT traversal techniques such as hole punching and use of IGD."

Since understanding the nat traversal techniques used is critical to understanding whether or not this package will work in a particular use case, please document all techniques used, ideally also summarizing the cases that are and aren't covered by those techniques. That kind of documentation is critical for understanding the expected behavior of this code.