mirror of
https://github.com/fluencelabs/js-libp2p
synced 2025-03-28 05:11:04 +00:00
199395de4d
Converts this module to typescript.
- Ecosystem modules renamed from (e.g.) `libp2p-tcp` to `@libp2p/tcp`
- Ecosystem module now have named exports
- Configuration has been updated, now pass instances of modules instead of classes:
- Some configuration keys have been renamed to make them more descriptive. `transport` -> `transports`, `connEncryption` -> `connectionEncryption`. In general where we pass multiple things, the key is now plural, e.g. `streamMuxer` -> `streamMuxers`, `contentRouting` -> `contentRouters`, etc. Where we are configuring a singleton the config key is singular, e.g. `connProtector` -> `connectionProtector` etc.
- Properties of the `modules` config key have been moved to the root
- Properties of the `config` config key have been moved to the root
```js
// before
import Libp2p from 'libp2p'
import TCP from 'libp2p-tcp'
await Libp2p.create({
modules: {
transport: [
TCP
],
}
config: {
transport: {
[TCP.tag]: {
foo: 'bar'
}
},
relay: {
enabled: true,
hop: {
enabled: true,
active: true
}
}
}
})
```
```js
// after
import { createLibp2p } from 'libp2p'
import { TCP } from '@libp2p/tcp'
await createLibp2p({
transports: [
new TCP({ foo: 'bar' })
],
relay: {
enabled: true,
hop: {
enabled: true,
active: true
}
}
})
```
- Use of `enabled` flag has been reduced - previously you could pass a module but disable it with config. Now if you don't want a feature, just don't pass an implementation. Eg:
```js
// before
await Libp2p.create({
modules: {
transport: [
TCP
],
pubsub: Gossipsub
},
config: {
pubsub: {
enabled: false
}
}
})
```
```js
// after
await createLibp2p({
transports: [
new TCP()
]
})
```
- `.multiaddrs` renamed to `.getMultiaddrs()` because it's not a property accessor, work is done by that method to calculate announce addresses, observed addresses, etc
- `/p2p/${peerId}` is now appended to all addresses returned by `.getMultiaddrs()` so they can be used opaquely (every consumer has to append the peer ID to the address to actually use it otherwise). If you need low-level unadulterated addresses, call methods on the address manager.
BREAKING CHANGE: types are no longer hand crafted, this module is now ESM only
❗❗Outdated: This example is still not refactored with the 0.27.* release.
WIP on libp2p/js-libp2p#507
Delegated Routing with Libp2p and IPFS
This example shows how to use delegated peer and content routing. The Peer and Content Routing Example 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 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.
Running this example
- Install IPFS locally if you dont already have it. Install Guide
- Run the IPFS daemon:
ipfs daemon - The daemon will output a line about its API address, like
API server listening on /ip4/127.0.0.1/tcp/8080 - In another window output the addresses of the node:
ipfs id. Make note of the websocket address, it will contain/ws/in the address. - In
./src/libp2p-bundle.jscheck if the host and port of your node are correct, according to the previous step. If they are different, replace them. - In
./src/App.jsreplaceBootstrapNodewith your nodes Websocket address from step 4. - 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.
- Your browser should show you connected to at least 1 peer.
Finding Content via the Delegate
- Add a file to your IPFS node. From this example root you can do
ipfs add ./README.mdto add the example readme. - Copy the hash from line 5, it will look something like Qmf33vz4HJFkqgH7XPP1uA6atYKTX1BWQEQthzpKcAdeyZ.
- 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
- Get a list of your delegate nodes peer by querying the IPFS daemon:
ipfs swarm peers - 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. - In your browser, paste the CID into the Peer field and hit
Find. - You should see information about the peer including its addresses.