refactor: switch to async iterators

[vasco-santos]

BREAKING CHANGE: Switch to using async/await and async iterators. The transport and connection interfaces have changed.

In the context of ipfs/js-ipfs#1670

Interface Transport

dial(ma<Multiaddr>, [options<Object>]): Promise<Connection>

Dial to a peer at the given multiaddr, returns a promise that is resolved when the connection has opened. Throws if connection error or any other error opening the connection, including if the connection is aborted.

The promise resolves to a Connection (which is a duplex object) that can be used to communicate with the peer.

Options

• signal - an AbortSignal that can be used to abort the dial. You can obtain one from an AbortController

createListener([options<Object>], [handler<Function<Connection>>]): Listener

Create a new listener, where incoming connections are handled by handler. The handler function is called for each new incoming connection. It is passed a Connection (which is a duplex object). Note the handler param is optional and can be registered later by listening for the 'connected' event.

filter(mas<Multiaddr[]>): Multiaddr[]

Filter the multiaddrs this transport can dial.

Events

listening

After the listener has started listening.

connected

For every new connection. The event handler is passed a Connection (which is a duplex object).

close

After the listener has stopped listening.

Interface Listener

listen(): Promise

getAddrs(): Promise<Multiaddr[]>

Interface Connection

sink<Function>

https://gist.github.com/alanshaw/591dc7dd54e4f99338a347ef568d6ee9#sink-it

source<Iterable>

https://gist.github.com/alanshaw/591dc7dd54e4f99338a347ef568d6ee9#source-it

getObservedAddrs(): Promise<Multiaddr[]>

close(): Promise

[vasco-santos]

There is a bug for: abort while reading throws AbortError (test from interface-transport). In order to not block this, I will open an issue to get it fixed afterward since we did not support aborts before. As a consequence, we are currently using a branch of interface-transport

[jacobheun]

LGTM!