AtHeartEngineer/universal-connectivity
1
0
Fork 0
mirror of https://github.com/vacp2p/universal-connectivity.git synced 2026-01-09 15:18:05 -05:00
Code Issues Packages Projects Releases Wiki Activity

feat: create circuit relay reservations on bootstrappers (#118)

Browse Source 
* feat: create circuit relay reservations on bootstrappers

* feat: persistent peer id in js-peer

* fix: pass relay listen addrs to libp2p

* Revert "feat: persistent peer id in js-peer"

Turns out this is a bad idea in a browser that can have multiple tabs
open and you don't want them to share the same peer ID

This reverts commit 50175a2fc9aff0668c399f88dc3f16636a39ee57.

* fix: import missing type

---------

Co-authored-by: Daniel N <2color@users.noreply.github.com>
This commit is contained in:
Daniel Norman
2024-05-03 16:13:24 +02:00
committed by GitHub
parent d6aa4c8d49
commit 6354a4abb2
1 changed files with 94 additions and 55 deletions
Download Patch File Download Diff File Expand all files Collapse all files

149
js-peer/src/lib/libp2p.ts
View File

@@ -1,21 +1,31 @@
import { IDBDatastore } from 'datastore-idb'
import { createDelegatedRoutingV1HttpApiClient } from '@helia/delegated-routing-v1-http-api-client'
import {
createDelegatedRoutingV1HttpApiClient,
DelegatedRoutingV1HttpApiClient,
} from '@helia/delegated-routing-v1-http-api-client'
import { createLibp2p, Libp2p } from 'libp2p'
import { identify } from '@libp2p/identify'
import {peerIdFromString} from '@libp2p/peer-id'
import { peerIdFromString } from '@libp2p/peer-id'
import { noise } from '@chainsafe/libp2p-noise'
import { yamux } from '@chainsafe/libp2p-yamux'
import { bootstrap } from '@libp2p/bootstrap'
import { Multiaddr } from '@multiformats/multiaddr'
import { sha256 } from 'multiformats/hashes/sha2'
import type { Message, SignedMessage } from '@libp2p/interface'
import type { Message, SignedMessage, PeerId } from '@libp2p/interface'
import { gossipsub } from '@chainsafe/libp2p-gossipsub'
import { webSockets } from '@libp2p/websockets'
import { webTransport } from '@libp2p/webtransport'
import { webRTC, webRTCDirect } from '@libp2p/webrtc'
import { CHAT_FILE_TOPIC, CHAT_TOPIC, WEBRTC_BOOTSTRAP_PEER_ID, WEBTRANSPORT_BOOTSTRAP_PEER_ID } from './constants'
import * as filters from "@libp2p/websockets/filters"
import {
CHAT_FILE_TOPIC,
CHAT_TOPIC,
WEBRTC_BOOTSTRAP_PEER_ID,
WEBTRANSPORT_BOOTSTRAP_PEER_ID,
} from './constants'
import * as filters from '@libp2p/websockets/filters'
import { circuitRelayTransport } from '@libp2p/circuit-relay-v2'
import first from 'it-first'
export async function startLibp2p() {
// enable verbose logging in browser console to view debug logs
@@ -23,62 +33,57 @@ export async function startLibp2p() {
// application-specific data lives in the datastore
const datastore = new IDBDatastore('universal-connectivity')
await datastore.open()
const delegatedClient = createDelegatedRoutingV1HttpApiClient('https://delegated-ipfs.dev')
const { bootstrapAddrs, relayListenAddrs } = await getBootstrapMultiaddrs(delegatedClient)
const libp2p = await createLibp2p({
datastore,
addresses: {
listen: [
// 👇 Listen for webRTC connection
'/webrtc'
]
'/webrtc',
// Use the app's bootstrap nodes as circuit relays
...relayListenAddrs,
],
},
transports: [
webTransport(),
webSockets(),
webRTC({
rtcConfiguration: {
iceServers: [{
// STUN servers help the browser discover its own public IPs
urls: [
'stun:stun.l.google.com:19302',
'stun:global.stun.twilio.com:3478'
]
}]
}
iceServers: [
{
// STUN servers help the browser discover its own public IPs
urls: ['stun:stun.l.google.com:19302', 'stun:global.stun.twilio.com:3478'],
},
],
},
}),
webRTCDirect(),
// 👇 Required to create circuit relay reservations in order to hole punch browser-to-browser WebRTC connections
circuitRelayTransport({
// When set to >0, this will look up the magic CID in order to discover circuit relay peers it can create a reservation with
discoverRelays: 1,
})
discoverRelays: 0,
}),
],
connectionManager: {
maxConnections: 10,
minConnections: 3
minConnections: 3,
},
connectionEncryption: [noise()],
streamMuxers: [yamux()],
connectionGater: {
denyDialMultiaddr: async () => false,
},
// The app-specific go and rust peers use WebTransport and WebRTC-direct which have ephemeral multiadrrs that change.
// Thus, we dial them using only their peer id below, with delegated routing to discovery their multiaddrs
// peerDiscovery: [
// bootstrap({
// list: [
// '12D3KooWFhXabKDwALpzqMbto94sB7rvmZ6M28hs9Y9xSopDKwQr'
// WEBRTC_BOOTSTRAP_NODE,
// WEBTRANSPORT_BOOTSTRAP_NODE,
// '/dnsaddr/bootstrap.libp2p.io/p2p/QmNnooDu7bfjPFoTZYxMNLWUQJyrVwtbZg5gBMjTezGAJN',
// '/dnsaddr/bootstrap.libp2p.io/p2p/QmQCU2EcMqAqQPR2i9bChDtGNJchTbq5TbXJJ16u19uLTa',
// '/dnsaddr/bootstrap.libp2p.io/p2p/QmbLHAnMoJPWSCR5Zhtx6BHJX9KiKNN6tpvbUcqanj75Nb',
// '/dnsaddr/bootstrap.libp2p.io/p2p/QmcZf59bWwK5XFi76CZX8cbJ4BhTzzA3gU1ZjYZcYW3dwt',
// ],
// }),
// ],
peerDiscovery: [
bootstrap({
// The app-specific go and rust bootstrappers use WebTransport and WebRTC-direct which have ephemeral multiadrrs
// that are resolved above using the delegated routing API
list: bootstrapAddrs,
}),
],
services: {
pubsub: gossipsub({
allowPublishToZeroTopicPeers: true,
@@ -87,24 +92,20 @@ export async function startLibp2p() {
}),
// Delegated routing helps us discover the ephemeral multiaddrs of the dedicated go and rust bootstrap peers
// This relies on the public delegated routing endpoint https://docs.ipfs.tech/concepts/public-utilities/#delegated-routing
delegatedRouting: () => createDelegatedRoutingV1HttpApiClient('https://delegated-ipfs.dev'),
identify: identify()
delegatedRouting: () => delegatedClient,
identify: identify(),
},
})
libp2p.services.pubsub.subscribe(CHAT_TOPIC)
libp2p.services.pubsub.subscribe(CHAT_FILE_TOPIC)
// Try connecting to bootstrap ppers
Promise.all([
libp2p.dial(peerIdFromString(WEBRTC_BOOTSTRAP_PEER_ID)),
libp2p.dial(peerIdFromString(WEBTRANSPORT_BOOTSTRAP_PEER_ID))
])
.catch(e => {console.log('woot', e)})
// .catch((e) => {
// console.log('woot', e)
// })
libp2p.addEventListener('self:peer:update', ({ detail: { peer } }) => {
const multiaddrs = peer.addresses.map(({ multiaddr }) => multiaddr)
console.log(`changed multiaddrs: peer ${peer.id.toString()} multiaddrs: ${multiaddrs}`)
})
@@ -115,24 +116,62 @@ export async function startLibp2p() {
// every agent in network should use the same message id function
// messages could be perceived as duplicate if this isnt added (as opposed to rust peer which has unique message ids)
export async function msgIdFnStrictNoSign(msg: Message): Promise<Uint8Array> {
var enc = new TextEncoder();
var enc = new TextEncoder()
const signedMessage = msg as SignedMessage
const encodedSeqNum = enc.encode(signedMessage.sequenceNumber.toString());
const encodedSeqNum = enc.encode(signedMessage.sequenceNumber.toString())
return await sha256.encode(encodedSeqNum)
}
export const connectToMultiaddr = (libp2p: Libp2p) => async (multiaddr: Multiaddr) => {
console.log(`dialling: ${multiaddr.toString()}`)
try {
const conn = await libp2p.dial(multiaddr)
console.info('connected to', conn.remotePeer, 'on', conn.remoteAddr)
return conn
} catch (e) {
console.error(e)
throw e
}
}
export const connectToMultiaddr =
(libp2p: Libp2p) => async (multiaddr: Multiaddr) => {
console.log(`dialling: ${multiaddr.toString()}`)
try {
const conn = await libp2p.dial(multiaddr)
console.info('connected to', conn.remotePeer, 'on', conn.remoteAddr)
return conn
} catch (e) {
console.error(e)
throw e
// Function which resolves PeerIDs of rust/go bootstrap nodes to multiaddrs dialable from the browser
// Returns both the dialable multiaddrs in addition to the relay
async function getBootstrapMultiaddrs(
client: DelegatedRoutingV1HttpApiClient,
): Promise<BootstrapsMultiaddrs> {
const peers = await Promise.all([
first(client.getPeers(peerIdFromString(WEBTRANSPORT_BOOTSTRAP_PEER_ID))),
first(client.getPeers(peerIdFromString(WEBRTC_BOOTSTRAP_PEER_ID))),
])
const bootstrapAddrs = []
const relayListenAddrs = []
for (const p of peers) {
if (p && p.Addrs.length > 0) {
for (const maddr of p.Addrs) {
const protos = maddr.protoNames()
if (
(protos.includes('webtransport') || protos.includes('webrtc-direct')) &&
protos.includes('certhash')
) {
if (maddr.nodeAddress().address === '127.0.0.1') continue // skip loopback
bootstrapAddrs.push(maddr.toString())
relayListenAddrs.push(getRelayListenAddr(maddr, p.ID))
}
}
}
}
return { bootstrapAddrs, relayListenAddrs }
}
interface BootstrapsMultiaddrs {
// Multiaddrs that are dialable from the browser
bootstrapAddrs: string[]
// multiaddr string representing the circuit relay v2 listen addr
relayListenAddrs: string[]
}
// Constructs a multiaddr string representing the circuit relay v2 listen address for a relayed connection to the given peer.
const getRelayListenAddr = (maddr: Multiaddr, peer: PeerId): string =>
`${maddr.toString()}/p2p/${peer.toString()}/p2p-circuit`