delegated-routing

@libp2p/example-delegated-routing-example

How to configure libp2p delegated routers

Table of contents

• Prerequisite
• Running this example
  • Finding Content via the Delegate
  • Finding Peers via the Delegate
• License
• Contribution

The starting Libp2p Bundle 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

This example uses a publicly known delegated routing node. This aims to ease experimentation, but you should not rely on this in production.

Running this example

1. Install IPFS locally if you dont already have it. Install Guide
2. Run the IPFS daemon: ipfs daemon
3. In another window output the addresses of the node: ipfs id. Make note of the websocket address, it will contain /ws/ in the address.

• If there is no websocket address, you will need to add it in the ipfs config file (~/.ipfs/config)
• Add to Swarm Addresses something like: "/ip4/127.0.0.1/tcp/4010/ws"

4. In ./src/App.js replace BootstrapNode with your nodes Websocket address from the step above.
5. Start this example

npm install
npm start

This should open your browser to http://localhost:3000. If it does not, go ahead and do that now.

6. 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.

License

Licensed under either of

• Apache 2.0, (LICENSE-APACHE / http://www.apache.org/licenses/LICENSE-2.0)
• MIT (LICENSE-MIT / http://opensource.org/licenses/MIT)

Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.