Tracking issue: roadmap to stabilization

[tomaka]

This issue should serve as a tracking issue for the roadmap to the first stable-ish version of rust-libp2p.
The core of the library has recently been rewritten and since then things have been a bit blurry, hence the need for an issue like this.

Things to do before a stable version of is possible:

• Agree on a ProtocolsHandler trait. (Add ProtocolsHandler trait #573)
• Rewrite Kademlia to use ProtocolsHandler (Add a KademliaHandler #580)
• Rewrite Floodsub to use ProtocolsHandler (Rewrite floodsub to use the ProtocolsHandler #603).
• Rewrite Relay to use ProtocolsHandler ([WIP] Put back the relay #585). (Remove relay, peerstore and datastore #723)
• Rewrite Ping to use ProtocolsHandler (Add a PeriodicPingHandler and a PingListenHandler #574)
• Rewrite Identify to use ProtocolsHandler (Add a PeriodicIdentification protocol handler #579)
• Add a NetworkBehaviour trait.
• Thoroughly document the submodules of the nodes module. (good enough for now; can be improved later)
• Add a NetworkBehaviour implementation of Kademlia (Add a KademliaHandler #580).
• Add a NetworkBehaviour implementation of Floodsub (Rewrite floodsub to use the ProtocolsHandler #603).
• Add a NetworkBehaviour implementation of Relay ([WIP] Put back the relay #585). (Remove relay, peerstore and datastore #723)
• Add a NetworkBehaviour implementation of Ping (Add implementations of NetworkBehaviour for ping #618).
• Add a NetworkBehaviour implementation of Identify (Add a PeriodicIdentifyBehaviour #617).
• Add an easy way to combine multiple NetworkBehaviours together, like a custom derive or a procedural macro (Add a custom derive for NetworkBehaviour #619).
• Add some easy ways to write your own ProtocolsHandler (not strictly necessary, but not very hard to do). Crossed out, needs more thoughts
• Reorganize the modules within core.
• Agree on a naming scheme for everything (eg. the Handler, Behaviour, etc. suffixes) (Rename all the network behaviours to more basic names #726).
• Remove Box<Future> from the repository (Remove some boxed futures. #718 did it where necessary).
• Remove peerstore and datastore. (Remove relay, peerstore and datastore #723)
• Run rustfmt everywhere. (controversial; can be done later)
• Add appropriate metadata in all the Cargo.tomls (Add the appropriate metadata in all the Cargo.toml #698).
• Improve the identify network behaviour (Add an Identify behaviour #741).
• Add some helpers for the transport (Add helpers to create a transport with secio and mplex/yamux #735).
• Rename tcp-transport to tcp (Rename libp2p-tcp-transport to libp2p-tcp #762).

Let me know if I forgot something.

[dvdplm]

* Reorganize the modules within `core`.

Can you perhaps add some more detail to this one?

[jamesray1]

Add a NetworkBehaviour trait.

And add more detail for this one? Although I guess it's fairly obvious.

[tomaka]

Can you perhaps add some more detail to this one?

I'm particularly thinking about the content of nodes. The name nodes doesn't really make sense, and the fact that they are part of a module while many types are visible only from the root of the crate doesn't make sense to me either.

[tomaka]

And add more detail for this one? Although I guess it's fairly obvious.

Right now the NodeHandler (and ProtocolsHandler) emit and receive events for each individual node connected to us. However we also need code that acts over the network as a whole, for example performing Kademlia requests or handling floodsub in general.

Right now the user has do to that manually, which is both tedious and error prone. I think we need a system that makes it easy to plug functionalities together, and that would for example be a NetworkBehaviour trait.

[tomaka]

Agree on a naming scheme for everything (eg. the Handler, Behaviour, etc. suffixes).

I think it's a good idea to have behaviours named after the protocol (eg. KademliaBehaviour -> Kademlia, FloodsubBehaviour -> Floodsub, etc.), while upgrades and handlers should be in submodules.

[jamesray1]

Improve the identify network behaviour (#731).

I think this has the wrong PR?

[tomaka]

I'm going to close this, as we've done everything 🎉
Let's publish 0.1 soon-ish!