This repository has been archived by the owner on Jul 21, 2023. It is now read-only.
feat: compatibility with go-libp2p-mdns - option 2 #81
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This PR adds a compatibility class that allows a js-libp2p node to find a go-libp2p node (and vice versa) over MDNS.
It's implemented as a separate class so the two differing implementations do not get confused.
I've verified this is working correctly by running a go-ipfs and js-ipfs node with no boostrap nodes (and no other discovery methods) and verifying they find each other.
TODO:
* [ ] Add tests!
Some tips if you want to try this out:
* After you've run `ipfs init`, remember to remove the bootstrap nodes from the config file (`~/.ipfs/config`) of each node before you start up
* Use `ipfs log level mdns debug` for some go-ipfs mdns logs
* You can use the following script (after `npm link`ing this branch) to start a js-ipfs node with no bootstrap nodes and no discovery modules other than MDNS:
```js
const IPFS = require('ipfs')
const MDNS = require('libp2p-mdns')
const TCP = require('libp2p-tcp')
const ipfs = new IPFS({
repo: '/tmp/ipfs-mdns',
config: {
Bootstrap: []
},
libp2p: {
modules: {
peerDiscovery: [MDNS],
transport: [TCP]
}
}
})
ipfs.on('ready', async () => {
console.log('ipfs is ready')
console.log('My Peer ID:', (await ipfs.id()).id)
setInterval(async () => {
const peers = await ipfs.swarm.peers()
console.log(peers.length, 'peers:')
peers.forEach(p => console.log(p.peer.toB58String()))
}, 10000)
})
```
License: MIT
Signed-off-by: Alan Shaw <[email protected]>
License: MIT Signed-off-by: Alan Shaw <[email protected]>
License: MIT Signed-off-by: Alan Shaw <[email protected]>
Co-Authored-By: alanshaw <[email protected]>
License: MIT Signed-off-by: Alan Shaw <[email protected]>
License: MIT Signed-off-by: Alan Shaw <[email protected]>
License: MIT Signed-off-by: Alan Shaw <[email protected]>
License: MIT Signed-off-by: Alan Shaw <[email protected]>
License: MIT Signed-off-by: Alan Shaw <[email protected]>
License: MIT Signed-off-by: Alan Shaw <[email protected]>
ghost
assigned License: MIT Signed-off-by: Alan Shaw <[email protected]>
1 task
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR simply sends out a multicast "response" on an interval in a format that
go-libp2p-mdnsexpects. This works becausego-libp2psends a multicast query every 5 seconds and waits for responses to come in. Although they ideally should be sent unicast,go-libp2pstill accepts multicast responses.Note this allows
go-libp2pto discoverjs-libp2pnodes but not the other way around.