feat: auto relay network query #749

vasco-santos · 2020-09-11T17:05:25Z

This PR add to the auto-relay ambient discovery, the ability to query the network for providers of the hop relay service. This will be performed if there are not enough peers connected/known with that capability.

The concept of the libp2p discovery serviced is added here (still not formally, but will be once we integrate rendezvous).

The Circuit was decoupled into two parts, the Circuit Transport and the Relay Service. This decoupling is important, so that we have lifecycle methods (start and stop for the relay). These methods will be used for calling the discovery.advertise similarly to go-libp2p's relay implementation, as well as to future active relay service network query on start.

The advertise options were added with the same defaults as go

Needs:

feat: auto relay #723
chore: update delegate deps #753 -- Needs 0.30.x rebase from master
chore: auto relay multiaddr update push #748

vasco-santos · 2020-09-17T08:55:56Z

src/circuit/auto-relay.js

+        return
+      }
+
+      remoteMultiaddr = remoteAddrs[0].multiaddr


While there is no support for signed peer records via delegate nodes (HTTP API), we need to fallback here

This address selection logic isn't great. If we don't have a certified record we might just be taking their private address if it's first (which I am concerned could be pretty common). The known public relays won't have this problem because they don't advertise private addresses, but we should be doing some level of sorting here to get the "best" address

I added a sorter. In follow up PRs, I will add the support for custom sort function for dial and custom filter for announce. Then, it will be bubbled up to here. But I wanted to keep things simple in this PR

jacobheun

I like the separation of the circuit transport file 👍

test/relay/auto-relay.node.js

src/circuit/auto-relay.js

jacobheun · 2020-09-22T15:16:02Z

src/circuit/auto-relay.js

+    // Try to find relays to hop on the network
+    try {
+      const cid = await namespaceToCid(RELAY_RENDEZVOUS_NS)
+      for await (const provider of this._libp2p.contentRouting.findProviders(cid)) {


We don't have support to do this right now, but it would be great to actually prioritize the results of this based on latency of the connection. Worth adding an issue for a future enhancement here I think

Yeah, that would be good! I can create an issue for that. We should get that after the libp2p.discovery API, also with the rendezvous

src/circuit/constants.js

src/circuit/index.js

doc/CONFIGURATION.md

jacobheun · 2020-10-05T13:51:17Z

src/circuit/auto-relay.js

+        return
+      }
+
+      remoteMultiaddr = remoteAddrs[0].multiaddr


This address selection logic isn't great. If we don't have a certified record we might just be taking their private address if it's first (which I am concerned could be pretty common). The known public relays won't have this problem because they don't advertise private addresses, but we should be doing some level of sorting here to get the "best" address

src/circuit/index.js

src/config.js

Co-authored-by: Jacob Heun <jacobheun@gmail.com>

jacobheun

Last couple things otherwise this looks good

src/circuit/auto-relay.js

jacobheun

LGTM, I'll leave the rebase/squash in your hands in case there are other branches you have based on this one.

vasco-santos mentioned this pull request Sep 14, 2020

chore: update delegate deps #753

Merged

vasco-santos force-pushed the feat/auto-relay-network-query branch 2 times, most recently from baf0ff0 to 6bbd819 Compare September 15, 2020 07:56

vasco-santos mentioned this pull request Sep 15, 2020

[discovery] Add support for AutoRelay #699

Closed

vasco-santos force-pushed the feat/auto-relay-network-query branch 2 times, most recently from 7073965 to 26648a5 Compare September 17, 2020 08:14

vasco-santos commented Sep 17, 2020

View reviewed changes

jacobheun reviewed Sep 22, 2020

View reviewed changes

vasco-santos force-pushed the feat/auto-relay-network-query branch from 26648a5 to 8060470 Compare September 23, 2020 13:43

vasco-santos mentioned this pull request Sep 23, 2020

libp2p discovery should prioritize its results based on latency of the connection #758

Closed

vasco-santos force-pushed the feat/auto-relay-network-query branch 4 times, most recently from 2f00f6c to 3a119dc Compare September 25, 2020 15:29

vasco-santos force-pushed the 0.30.x branch from 8f40eb6 to 72fe150 Compare September 25, 2020 15:35

vasco-santos force-pushed the feat/auto-relay-network-query branch from 3a119dc to 6abea77 Compare September 25, 2020 15:42

vasco-santos marked this pull request as ready for review September 25, 2020 15:44

vasco-santos force-pushed the feat/auto-relay-network-query branch from 6abea77 to 57a07f1 Compare September 25, 2020 16:04

vasco-santos requested a review from jacobheun September 25, 2020 16:10

jacobheun reviewed Oct 5, 2020

View reviewed changes

vasco-santos force-pushed the feat/auto-relay-network-query branch from 285bd0b to 51e9e95 Compare October 5, 2020 15:27

vasco-santos force-pushed the 0.30.x branch from 894d8e3 to 6acc84b Compare October 7, 2020 15:31

vasco-santos and others added 5 commits October 7, 2020 17:51

feat: auto relay network query for new relays

77d3889

chore: address review

41b7b82

chore: add configuration docs for auto relay and hop service

ca1d7ec

chore: apply suggestions from code review

f026f49

Co-authored-by: Jacob Heun <jacobheun@gmail.com>

chore: lint issues fixed

8147383

vasco-santos force-pushed the feat/auto-relay-network-query branch from 51e9e95 to 8147383 Compare October 7, 2020 15:58

chore: sort relay addresses to listen for public first

9a69af3

vasco-santos requested a review from jacobheun October 8, 2020 09:10

jacobheun reviewed Oct 8, 2020

View reviewed changes

src/circuit/auto-relay.js Outdated Show resolved Hide resolved

chore: improve logging for auto relay active listen

6b4ee3c

vasco-santos requested a review from jacobheun October 8, 2020 18:17

jacobheun approved these changes Oct 9, 2020

View reviewed changes

vasco-santos merged commit 46e94d7 into 0.30.x Oct 9, 2020

vasco-santos deleted the feat/auto-relay-network-query branch October 9, 2020 13:20

vasco-santos restored the feat/auto-relay-network-query branch October 9, 2020 13:20

vasco-santos deleted the feat/auto-relay-network-query branch October 9, 2020 13:20

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: auto relay network query #749

feat: auto relay network query #749

vasco-santos commented Sep 11, 2020 •

edited

Loading

vasco-santos Sep 17, 2020 •

edited

Loading

jacobheun Oct 5, 2020

vasco-santos Oct 8, 2020

jacobheun left a comment

jacobheun Sep 22, 2020

vasco-santos Sep 23, 2020

vasco-santos Sep 23, 2020

jacobheun Oct 5, 2020

jacobheun left a comment

jacobheun left a comment

feat: auto relay network query #749

feat: auto relay network query #749

Conversation

vasco-santos commented Sep 11, 2020 • edited Loading

vasco-santos Sep 17, 2020 • edited Loading

Choose a reason for hiding this comment

jacobheun Oct 5, 2020

Choose a reason for hiding this comment

vasco-santos Oct 8, 2020

Choose a reason for hiding this comment

jacobheun left a comment

Choose a reason for hiding this comment

jacobheun Sep 22, 2020

Choose a reason for hiding this comment

vasco-santos Sep 23, 2020

Choose a reason for hiding this comment

vasco-santos Sep 23, 2020

Choose a reason for hiding this comment

jacobheun Oct 5, 2020

Choose a reason for hiding this comment

jacobheun left a comment

Choose a reason for hiding this comment

jacobheun left a comment

Choose a reason for hiding this comment

vasco-santos commented Sep 11, 2020 •

edited

Loading

vasco-santos Sep 17, 2020 •

edited

Loading