RFC: Handshaker Redesign about bip-rs HOT 4 CLOSED

Currently have some example code illustrating the above RFC, will upload soon.

from bip-rs.

Minimal example is up: https://github.com/GGist/bip-rs/tree/rfc_handshaker_example

Ping @astro

from bip-rs.

As a second thought, I think leaving off filter from the interface is best as I don't see that function being used generically. We could simply offer that functionality in concrete Handshakers.

from bip-rs.

Final Comment Period, will close as accepted in two days.

May change the naming of some of the items in the trait. Particularly, a more descriptive and specific name than Envelope since that Envelope could be metadata specific, it doesnt have to be the same type that connections are sent back to the client as.

A concrete Handshaker could decide to send connections down one channel and metadata down another for example. In that case, Envelope would not have a connections enum variant (like in our example). They could even choose to set Envelope as () and throwaway whatever is passed to it (we could provide From implementations for () for all metadata to support throwing away metadata like this without user's having to throw it away themselves).

Also, keep in mind that this metadata is what we will eventually use to send back information from DHT get and put commands.

from bip-rs.