mirror of
https://github.com/fluencelabs/js-libp2p
synced 2025-03-21 18:10:50 +00:00
a95389a28e
* feat: allow for configuring content and peer routing * feat: support multiple peer and content routing modules * docs: add delegated routing example
50 lines
3.0 KiB
Markdown
50 lines
3.0 KiB
Markdown
# Delegated Routing with Libp2p and IPFS
|
|
|
|
This example shows how to use delegated peer and content routing. The [Peer and Content Routing Example](../peer-and-content-routing) focuses
|
|
on the DHT implementation. This example takes that a step further and introduces delegated routing. Delegated routing is
|
|
especially useful when your libp2p node will have limited resources, making running a DHT impractical. It's
|
|
also highly useful if your node is generating content, but can't reliably be on the network. You can use delegate nodes
|
|
to provide content on your behalf.
|
|
|
|
The starting [Libp2p Bundle](./src/libp2p-bundle.js) in this example starts by disabling the DHT and adding the Delegated Peer and Content Routers.
|
|
Once you've completed the example, you should try enabled the DHT and see what kind of results you get! You can also enable the
|
|
various Peer Discovery modules and see the impact it has on your Peer count.
|
|
|
|
## Prerequisite
|
|
**NOTE**: This example is currently dependent on a clone of the [delegated routing support branch of go-ipfs](https://github.com/ipfs/go-ipfs/pull/4595).
|
|
|
|
## Running this example
|
|
|
|
1. Install IPFS locally if you dont already have it. [Install Guide](https://docs.ipfs.io/introduction/install/)
|
|
2. Run the IPFS daemon: `ipfs daemon`
|
|
3. The daemon will output a line about its API address, like `API server listening on /ip4/127.0.0.1/tcp/8080`
|
|
4. In another window output the addresses of the node: `ipfs id`. Make note of the websocket address, is will contain `/ws/` in the address.
|
|
5. In `./src/libp2p-bundle.js` replace the `delegatedApiOptions` host and port of your node if they are different.
|
|
6. In `./src/App.js` replace `BootstrapNode` with your nodes Websocket address from step 4.
|
|
7. Start this example:
|
|
|
|
```sh
|
|
npm install
|
|
npm start
|
|
```
|
|
|
|
This should open your browser to http://localhost:3000. If it does not, go ahead and do that now.
|
|
|
|
8. Your browser should show you connected to at least 1 peer.
|
|
|
|
### Finding Content via the Delegate
|
|
1. Add a file to your IPFS node. From this example root you can do `ipfs add ./README.md` to add the example readme.
|
|
2. Copy the hash from line 5, it will look something like *Qmf33vz4HJFkqgH7XPP1uA6atYKTX1BWQEQthzpKcAdeyZ*.
|
|
3. In the browser, paste the hash into the *Hash* field and hit `Find`. The readme contents should display.
|
|
|
|
This will do a few things:
|
|
* The delegate nodes api will be queried to find providers of the content
|
|
* The content will be fetched from the providers
|
|
* Since we now have the content, we tell the delegate node to fetch the content from us and become a provider
|
|
|
|
### Finding Peers via the Delegate
|
|
1. Get a list of your delegate nodes peer by querying the IPFS daemon: `ipfs swarm peers`
|
|
2. Copy one of the CIDs from the list of peer addresses, this will be the last portion of the address and will look something like `QmdoG8DpzYUZMVP5dGmgmigZwR1RE8Cf6SxMPg1SBXJAQ8`.
|
|
3. In your browser, paste the CID into the *Peer* field and hit `Find`.
|
|
4. You should see information about the peer including its addresses.
|