Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix!: remove protocols from PeerInfo #2166

Merged
merged 1 commit into from
Oct 24, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -49,8 +49,7 @@ export class MockDiscovery extends EventEmitter<PeerDiscoveryEvents> implements
this.safeDispatchEvent<PeerInfo>('peer', {
detail: {
id: peerId,
multiaddrs: [multiaddr('/ip4/127.0.0.1/tcp/8000')],
protocols: []
multiaddrs: [multiaddr('/ip4/127.0.0.1/tcp/8000')]
}
})
}, this.options.discoveryDelay ?? 1000)
Expand Down
14 changes: 13 additions & 1 deletion packages/interface/src/peer-info/index.ts
Original file line number Diff line number Diff line change
@@ -1,8 +1,20 @@
import type { PeerId } from '../peer-id/index.js'
import type { Multiaddr } from '@multiformats/multiaddr'

/**
* A `PeerInfo` is a lightweight object that represents a remote peer, it can be
* obtained from peer discovery mechanisms, HTTP RPC endpoints, etc.
*
* @see https://docs.libp2p.io/concepts/fundamentals/peers/#peer-info
*/
export interface PeerInfo {
/**
* The identifier of the remote peer
*/
id: PeerId

/**
* The multiaddrs a peer is listening on
*/
multiaddrs: Multiaddr[]
protocols: string[]
}
6 changes: 2 additions & 4 deletions packages/kad-dht/src/content-routing/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -64,8 +64,7 @@ export class ContentRouting {
const msg = new Message(MESSAGE_TYPE.ADD_PROVIDER, key.multihash.bytes, 0)
msg.providerPeers = [{
id: this.components.peerId,
multiaddrs,
protocols: []
multiaddrs
}]

let sent = 0
Expand Down Expand Up @@ -140,8 +139,7 @@ export class ContentRouting {

providers.push({
id: peerId,
multiaddrs: peer.addresses.map(({ multiaddr }) => multiaddr),
protocols: peer.protocols
multiaddrs: peer.addresses.map(({ multiaddr }) => multiaddr)
})
} catch (err: any) {
if (err.code !== 'ERR_NOT_FOUND') {
Expand Down
2 changes: 1 addition & 1 deletion packages/kad-dht/src/kad-dht.ts
Original file line number Diff line number Diff line change
Expand Up @@ -218,7 +218,7 @@ export class DefaultKadDHT extends EventEmitter<PeerDiscoveryEvents> implements
}

async onPeerConnect (peerData: PeerInfo): Promise<void> {
this.log('peer %p connected with protocols', peerData.id, peerData.protocols)
this.log('peer %p connected', peerData.id)

if (this.lan) {
peerData = removePublicAddresses(peerData)
Expand Down
3 changes: 1 addition & 2 deletions packages/kad-dht/src/message/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -104,7 +104,6 @@ function fromPbPeer (peer: PBMessage.Peer): PeerInfo {

return {
id: peerIdFromBytes(peer.id),
multiaddrs: (peer.addrs ?? []).map((a) => multiaddr(a)),
protocols: []
multiaddrs: (peer.addrs ?? []).map((a) => multiaddr(a))
}
}
9 changes: 3 additions & 6 deletions packages/kad-dht/src/peer-routing/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -85,8 +85,7 @@ export class PeerRouting {

return {
id: peerData.id,
multiaddrs: peerData.addresses.map((address) => address.multiaddr),
protocols: []
multiaddrs: peerData.addresses.map((address) => address.multiaddr)
}
}

Expand Down Expand Up @@ -226,8 +225,7 @@ export class PeerRouting {
from: this.components.peerId,
peer: {
id: peerId,
multiaddrs: peer.addresses.map(({ multiaddr }) => multiaddr),
protocols: peer.protocols
multiaddrs: peer.addresses.map(({ multiaddr }) => multiaddr)
}
}, options)
} catch (err: any) {
Expand Down Expand Up @@ -296,8 +294,7 @@ export class PeerRouting {

output.push({
id: peerId,
multiaddrs: peer.addresses.map(({ multiaddr }) => multiaddr),
protocols: peer.protocols
multiaddrs: peer.addresses.map(({ multiaddr }) => multiaddr)
})
} catch (err: any) {
if (err.code !== 'ERR_NOT_FOUND') {
Expand Down
3 changes: 1 addition & 2 deletions packages/kad-dht/src/rpc/handlers/find-node.ts
Original file line number Diff line number Diff line change
Expand Up @@ -48,8 +48,7 @@ export class FindNodeHandler implements DHTMessageHandler {
if (uint8ArrayEquals(this.components.peerId.toBytes(), msg.key)) {
closer = [{
id: this.components.peerId,
multiaddrs: this.components.addressManager.getAddresses().map(ma => ma.decapsulateCode(protocols('p2p').code)),
protocols: []
multiaddrs: this.components.addressManager.getAddresses().map(ma => ma.decapsulateCode(protocols('p2p').code))
}]
} else {
closer = await this.peerRouting.getCloserPeersOffline(msg.key, peerId)
Expand Down
3 changes: 1 addition & 2 deletions packages/kad-dht/src/rpc/handlers/get-providers.ts
Original file line number Diff line number Diff line change
Expand Up @@ -86,8 +86,7 @@ export class GetProvidersHandler implements DHTMessageHandler {

const peerAfterFilter = addrFilter({
id: peerId,
multiaddrs: peer.addresses.map(({ multiaddr }) => multiaddr),
protocols: peer.protocols
multiaddrs: peer.addresses.map(({ multiaddr }) => multiaddr)
})

if (peerAfterFilter.multiaddrs.length > 0) {
Expand Down
4 changes: 2 additions & 2 deletions packages/kad-dht/test/kad-utils.spec.ts
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@ describe('kad utils', () => {
multiaddr('/dns4/localhost/tcp/4001')
]

const peerInfo = utils.removePrivateAddresses({ id, multiaddrs, protocols: [] })
const peerInfo = utils.removePrivateAddresses({ id, multiaddrs })
expect(peerInfo.multiaddrs.map((ma) => ma.toString()))
.to.eql(['/dns4/example.com/tcp/4001', '/ip4/1.1.1.1/tcp/4001'])
})
Expand All @@ -90,7 +90,7 @@ describe('kad utils', () => {
multiaddr('/dns4/localhost/tcp/4001')
]

const peerInfo = utils.removePublicAddresses({ id, multiaddrs, protocols: [] })
const peerInfo = utils.removePublicAddresses({ id, multiaddrs })
expect(peerInfo.multiaddrs.map((ma) => ma.toString()))
.to.eql(['/ip4/192.168.0.1/tcp/4001', '/dns4/localhost/tcp/4001'])
})
Expand Down
6 changes: 2 additions & 4 deletions packages/kad-dht/test/query-self.spec.ts
Original file line number Diff line number Diff line change
Expand Up @@ -78,8 +78,7 @@ describe('Query Self', () => {
from: remotePeer,
peer: {
id: remotePeer,
multiaddrs: [],
protocols: []
multiaddrs: []
}
})
}())
Expand Down Expand Up @@ -110,8 +109,7 @@ describe('Query Self', () => {
from: remotePeer,
peer: {
id: remotePeer,
multiaddrs: [],
protocols: []
multiaddrs: []
}
})
}())
Expand Down
3 changes: 1 addition & 2 deletions packages/kad-dht/test/query.spec.ts
Original file line number Diff line number Diff line change
Expand Up @@ -534,8 +534,7 @@ describe('QueryManager', () => {
messageType: MESSAGE_TYPE.GET_VALUE,
closer: [{
id: peers[2],
multiaddrs: [],
protocols: []
multiaddrs: []
}]
})
}
Expand Down
6 changes: 2 additions & 4 deletions packages/kad-dht/test/rpc/handlers/add-provider.spec.ts
Original file line number Diff line number Diff line change
Expand Up @@ -68,12 +68,10 @@ describe('rpc - handlers - AddProvider', () => {

msg.providerPeers = [{
id: peerIds[0],
multiaddrs: [ma1],
protocols: []
multiaddrs: [ma1]
}, {
id: peerIds[1],
multiaddrs: [ma2],
protocols: []
multiaddrs: [ma2]
}]

await handler.handle(peerIds[0], msg)
Expand Down
9 changes: 3 additions & 6 deletions packages/kad-dht/test/rpc/handlers/find-node.spec.ts
Original file line number Diff line number Diff line change
Expand Up @@ -71,8 +71,7 @@ describe('rpc - handlers - FindNode', () => {
multiaddr('/ip4/127.0.0.1/tcp/4002'),
multiaddr('/ip4/192.168.1.5/tcp/4002'),
multiaddr('/ip4/221.4.67.0/tcp/4002')
],
protocols: []
]
}])

const response = await handler.handle(sourcePeer, msg)
Expand Down Expand Up @@ -109,8 +108,7 @@ describe('rpc - handlers - FindNode', () => {
multiaddr('/ip4/127.0.0.1/tcp/4002'),
multiaddr('/ip4/192.168.1.5/tcp/4002'),
multiaddr('/ip4/221.4.67.0/tcp/4002')
],
protocols: []
]
}])

handler = new FindNodeHandler({
Expand Down Expand Up @@ -146,8 +144,7 @@ describe('rpc - handlers - FindNode', () => {
multiaddr('/ip4/127.0.0.1/tcp/4002'),
multiaddr('/ip4/192.168.1.5/tcp/4002'),
multiaddr('/ip4/221.4.67.0/tcp/4002')
],
protocols: []
]
}])

const response = await handler.handle(sourcePeer, msg)
Expand Down
6 changes: 2 additions & 4 deletions packages/kad-dht/test/rpc/handlers/get-providers.spec.ts
Original file line number Diff line number Diff line change
Expand Up @@ -73,8 +73,7 @@ describe('rpc - handlers - GetProviders', () => {
multiaddr('/ip4/127.0.0.1/tcp/4002'),
multiaddr('/ip4/192.168.2.6/tcp/4002'),
multiaddr('/ip4/21.31.57.23/tcp/4002')
],
protocols: []
]
}]

const provider: PeerInfo[] = [{
Expand All @@ -83,8 +82,7 @@ describe('rpc - handlers - GetProviders', () => {
multiaddr('/ip4/127.0.0.1/tcp/4002'),
multiaddr('/ip4/192.168.1.5/tcp/4002'),
multiaddr('/ip4/135.4.67.0/tcp/4002')
],
protocols: []
]
}]

providers.getProviders.withArgs(v.cid).resolves([providerPeer])
Expand Down
3 changes: 1 addition & 2 deletions packages/kad-dht/test/rpc/handlers/get-value.spec.ts
Original file line number Diff line number Diff line change
Expand Up @@ -94,8 +94,7 @@ describe('rpc - handlers - GetValue', () => {
peerRouting.getCloserPeersOffline.withArgs(key, sourcePeer)
.resolves([{
id: closerPeer,
multiaddrs: [],
protocols: []
multiaddrs: []
}])

const msg = new Message(T, key, 0)
Expand Down
3 changes: 1 addition & 2 deletions packages/kad-dht/test/utils/test-dht.ts
Original file line number Diff line number Diff line change
Expand Up @@ -94,8 +94,7 @@ export class TestDHT {
}

components.peerStore.merge(peerData.id, {
multiaddrs: peerData.multiaddrs,
protocols: peerData.protocols
multiaddrs: peerData.multiaddrs
})
.catch(err => { log.error(err) })
})
Expand Down
6 changes: 2 additions & 4 deletions packages/libp2p/src/libp2p.ts
Original file line number Diff line number Diff line change
Expand Up @@ -101,8 +101,7 @@ export class Libp2pNode<T extends ServiceMap = Record<string, unknown>> extends
if (evt.detail.previous == null) {
const peerInfo: PeerInfo = {
id: evt.detail.peer.id,
multiaddrs: evt.detail.peer.addresses.map(a => a.multiaddr),
protocols: evt.detail.peer.protocols
multiaddrs: evt.detail.peer.addresses.map(a => a.multiaddr)
}

components.events.safeDispatchEvent('peer:discovery', { detail: peerInfo })
Expand Down Expand Up @@ -399,8 +398,7 @@ export class Libp2pNode<T extends ServiceMap = Record<string, unknown>> extends
}

void this.components.peerStore.merge(peer.id, {
multiaddrs: peer.multiaddrs,
protocols: peer.protocols
multiaddrs: peer.multiaddrs
})
.catch(err => { log.error(err) })
}
Expand Down
3 changes: 1 addition & 2 deletions packages/libp2p/test/circuit-relay/utils.ts
Original file line number Diff line number Diff line change
Expand Up @@ -142,8 +142,7 @@ export class MockContentRouting implements ContentRouting {

providers.push({
id: this.peerId,
multiaddrs: this.addressManager.getAddresses(),
protocols: []
multiaddrs: this.addressManager.getAddresses()
})

MockContentRouting.providers.set(cid.toString(), providers)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -251,8 +251,7 @@ describe('content-routing', () => {
id: providerPeerId,
multiaddrs: [
multiaddr('/ip4/123.123.123.123/tcp/49320')
],
protocols: []
]
}

if (node.services.dht == null) {
Expand Down
3 changes: 1 addition & 2 deletions packages/peer-discovery-bootstrap/src/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -85,8 +85,7 @@ class Bootstrap extends EventEmitter<PeerDiscoveryEvents> implements PeerDiscove

const peerData: PeerInfo = {
id: peerIdFromString(peerIdStr),
multiaddrs: [ma],
protocols: []
multiaddrs: [ma]
}

this.list.push(peerData)
Expand Down
3 changes: 1 addition & 2 deletions packages/peer-discovery-mdns/src/query.ts
Original file line number Diff line number Diff line change
Expand Up @@ -74,8 +74,7 @@ export function gotResponse (rsp: ResponsePacket, localPeerName: string, service

return {
id: peerIdFromString(peerId),
multiaddrs: multiaddrs.map(addr => addr.decapsulateCode(protocols('p2p').code)),
protocols: []
multiaddrs: multiaddrs.map(addr => addr.decapsulateCode(protocols('p2p').code))
}
} catch (e) {
log.error('failed to parse mdns response', e)
Expand Down