Skip to content

Commit fdb48c8

Browse files
vasco-santosjacobheun
vasco-santos
and
jacobheun
committed
refactor: examples/peer-and-content-routing (#500)
* refactor: examples-peer-and-content-routing * chore: address review * chore: review suggestions Co-Authored-By: Jacob Heun <jacobheun@gmail.com>
1 parent 506af15 commit fdb48c8

File tree

3 files changed

+110
-169
lines changed

3 files changed

+110
-169
lines changed

‎examples/peer-and-content-routing/1.js

+37-59
Original file line numberDiff line numberDiff line change
@@ -1,77 +1,55 @@
11
/* eslint-disable no-console */
22
'use strict'
33

4-
const libp2p = require('../../')
4+
const Libp2p = require('../../')
55
const TCP = require('libp2p-tcp')
66
const Mplex = require('libp2p-mplex')
77
const SECIO = require('libp2p-secio')
88
const PeerInfo = require('peer-info')
99
const KadDHT = require('libp2p-kad-dht')
10-
const defaultsDeep = require('@nodeutils/defaults-deep')
11-
const waterfall = require('async/waterfall')
12-
const parallel = require('async/parallel')
1310

14-
class MyBundle extends libp2p {
15-
constructor (_options) {
16-
const defaults = {
17-
modules: {
18-
transport: [ TCP ],
19-
streamMuxer: [ Mplex ],
20-
connEncryption: [ SECIO ],
21-
// we add the DHT module that will enable Peer and Content Routing
22-
dht: KadDHT
23-
},
24-
config: {
25-
dht: {
26-
enabled: true,
27-
kBucketSize: 20
28-
}
11+
const delay = require('delay')
12+
13+
const createNode = async () => {
14+
const peerInfo = await PeerInfo.create()
15+
peerInfo.multiaddrs.add('/ip4/0.0.0.0/tcp/0')
16+
17+
const node = await Libp2p.create({
18+
peerInfo,
19+
modules: {
20+
transport: [TCP],
21+
streamMuxer: [Mplex],
22+
connEncryption: [SECIO],
23+
dht: KadDHT
24+
},
25+
config: {
26+
dht: {
27+
enabled: true
2928
}
3029
}
30+
})
3131

32-
super(defaultsDeep(_options, defaults))
33-
}
34-
}
35-
36-
function createNode (callback) {
37-
let node
38-
39-
waterfall([
40-
(cb) => PeerInfo.create(cb),
41-
(peerInfo, cb) => {
42-
peerInfo.multiaddrs.add('/ip4/0.0.0.0/tcp/0')
43-
node = new MyBundle({
44-
peerInfo
45-
})
46-
node.start(cb)
47-
}
48-
], (err) => callback(err, node))
32+
await node.start()
33+
return node
4934
}
5035

51-
parallel([
52-
(cb) => createNode(cb),
53-
(cb) => createNode(cb),
54-
(cb) => createNode(cb)
55-
], (err, nodes) => {
56-
if (err) { throw err }
36+
;(async () => {
37+
const [node1, node2, node3] = await Promise.all([
38+
createNode(),
39+
createNode(),
40+
createNode()
41+
])
5742

58-
const node1 = nodes[0]
59-
const node2 = nodes[1]
60-
const node3 = nodes[2]
43+
await Promise.all([
44+
node1.dial(node2.peerInfo),
45+
node2.dial(node3.peerInfo)
46+
])
6147

62-
parallel([
63-
(cb) => node1.dial(node2.peerInfo, cb),
64-
(cb) => node2.dial(node3.peerInfo, cb),
65-
// Set up of the cons might take time
66-
(cb) => setTimeout(cb, 300)
67-
], (err) => {
68-
if (err) { throw err }
48+
// The DHT routing tables need a moment to populate
49+
await delay(100)
6950

70-
node1.peerRouting.findPeer(node3.peerInfo.id, (err, peer) => {
71-
if (err) { throw err }
51+
const peer = await node1.peerRouting.findPeer(node3.peerInfo.id)
7252

73-
console.log('Found it, multiaddrs are:')
74-
peer.multiaddrs.forEach((ma) => console.log(ma.toString()))
75-
})
76-
})
77-
})
53+
console.log('Found it, multiaddrs are:')
54+
peer.multiaddrs.forEach((ma) => console.log(ma.toString()))
55+
})();

‎examples/peer-and-content-routing/2.js

+40-64
Original file line numberDiff line numberDiff line change
@@ -1,85 +1,61 @@
11
/* eslint-disable no-console */
22
'use strict'
33

4-
const libp2p = require('../../')
4+
const Libp2p = require('../../')
55
const TCP = require('libp2p-tcp')
66
const Mplex = require('libp2p-mplex')
77
const SECIO = require('libp2p-secio')
88
const PeerInfo = require('peer-info')
99
const CID = require('cids')
1010
const KadDHT = require('libp2p-kad-dht')
11-
const defaultsDeep = require('@nodeutils/defaults-deep')
12-
const waterfall = require('async/waterfall')
13-
const parallel = require('async/parallel')
1411

15-
class MyBundle extends libp2p {
16-
constructor (_options) {
17-
const defaults = {
18-
modules: {
19-
transport: [ TCP ],
20-
streamMuxer: [ Mplex ],
21-
connEncryption: [ SECIO ],
22-
// we add the DHT module that will enable Peer and Content Routing
23-
dht: KadDHT
24-
},
25-
config: {
26-
dht: {
27-
enabled: true,
28-
kBucketSize: 20
29-
}
12+
const all = require('it-all')
13+
const delay = require('delay')
14+
15+
const createNode = async () => {
16+
const peerInfo = await PeerInfo.create()
17+
peerInfo.multiaddrs.add('/ip4/0.0.0.0/tcp/0')
18+
19+
const node = await Libp2p.create({
20+
peerInfo,
21+
modules: {
22+
transport: [TCP],
23+
streamMuxer: [Mplex],
24+
connEncryption: [SECIO],
25+
dht: KadDHT
26+
},
27+
config: {
28+
dht: {
29+
enabled: true
3030
}
3131
}
32+
})
3233

33-
super(defaultsDeep(_options, defaults))
34-
}
34+
await node.start()
35+
return node
3536
}
3637

37-
function createNode (callback) {
38-
let node
39-
40-
waterfall([
41-
(cb) => PeerInfo.create(cb),
42-
(peerInfo, cb) => {
43-
peerInfo.multiaddrs.add('/ip4/0.0.0.0/tcp/0')
44-
node = new MyBundle({
45-
peerInfo
46-
})
47-
node.start(cb)
48-
}
49-
], (err) => callback(err, node))
50-
}
38+
;(async () => {
39+
const [node1, node2, node3] = await Promise.all([
40+
createNode(),
41+
createNode(),
42+
createNode()
43+
])
5144

52-
parallel([
53-
(cb) => createNode(cb),
54-
(cb) => createNode(cb),
55-
(cb) => createNode(cb)
56-
], (err, nodes) => {
57-
if (err) { throw err }
45+
await Promise.all([
46+
node1.dial(node2.peerInfo),
47+
node2.dial(node3.peerInfo)
48+
])
5849

59-
const node1 = nodes[0]
60-
const node2 = nodes[1]
61-
const node3 = nodes[2]
50+
const cid = new CID('QmTp9VkYvnHyrqKQuFPiuZkiX9gPcqj6x5LJ1rmWuSySnL')
51+
await node1.contentRouting.provide(cid)
6252

63-
parallel([
64-
(cb) => node1.dial(node2.peerInfo, cb),
65-
(cb) => node2.dial(node3.peerInfo, cb),
66-
// Set up of the cons might take time
67-
(cb) => setTimeout(cb, 300)
68-
], (err) => {
69-
if (err) { throw err }
53+
console.log('Node %s is providing %s', node1.peerInfo.id.toB58String(), cid.toBaseEncodedString())
7054

71-
const cid = new CID('QmTp9VkYvnHyrqKQuFPiuZkiX9gPcqj6x5LJ1rmWuSySnL')
55+
// wait for propagation
56+
await delay(300)
7257

73-
node1.contentRouting.provide(cid, (err) => {
74-
if (err) { throw err }
58+
const providers = await all(node3.contentRouting.findProviders(cid, { timeout: 3000 }))
7559

76-
console.log('Node %s is providing %s', node1.peerInfo.id.toB58String(), cid.toBaseEncodedString())
77-
78-
node3.contentRouting.findProviders(cid, 5000, (err, providers) => {
79-
if (err) { throw err }
80-
81-
console.log('Found provider:', providers[0].id.toB58String())
82-
})
83-
})
84-
})
85-
})
60+
console.log('Found provider:', providers[0].id.toB58String())
61+
})();

‎examples/peer-and-content-routing/README.md

+33-46
Original file line numberDiff line numberDiff line change
@@ -10,31 +10,27 @@ Content Routing is the category of modules that offer a way to find where conten
1010

1111
This example builds on top of the [Protocol and Stream Muxing](../protocol-and-stream-muxing). We need to install `libp2p-kad-dht`, go ahead and `npm install libp2p-kad-dht`. If you want to see the final version, open [1.js](./1.js).
1212

13-
First, let's update our bundle to support Peer Routing and Content Routing.
13+
First, let's update our config to support Peer Routing and Content Routing.
1414

1515
```JavaScript
16-
class MyBundle extends libp2p {
17-
constructor (_options) {
18-
const defaults = {
19-
modules: {
20-
transport: [ TCP ],
21-
streamMuxer: [ Mplex ],
22-
connEncryption: [ SECIO ],
23-
// we add the DHT module that will enable Peer and Content Routing
24-
dht: KadDHT
25-
},
26-
config: {
27-
dht: {
28-
// dht must be enabled
29-
enabled: true,
30-
kBucketSize: 20
31-
}
32-
}
16+
const Libp2p = require('libp2p')
17+
const KadDHT = require('libp2p-kad-dht')
18+
19+
const node = await Libp2p.create({
20+
modules: {
21+
transport: [ TCP ],
22+
streamMuxer: [ Mplex ],
23+
connEncryption: [ SECIO ],
24+
// we add the DHT module that will enable Peer and Content Routing
25+
dht: KadDHT
26+
},
27+
config: {
28+
dht: {
29+
// dht must be enabled
30+
enabled: true
3331
}
34-
35-
super(defaultsDeep(_options, defaults))
3632
}
37-
}
33+
})
3834
```
3935

4036
Once that is done, we can use the createNode function we developed in the previous example to create 3 nodes. Connect node 1 to node 2 and node 2 to node 3. We will use node 2 as a way to find the whereabouts of node 3
@@ -44,22 +40,18 @@ const node1 = nodes[0]
4440
const node2 = nodes[1]
4541
const node3 = nodes[2]
4642

47-
parallel([
48-
(cb) => node1.dial(node2.peerInfo, cb),
49-
(cb) => node2.dial(node3.peerInfo, cb),
50-
// Set up of the cons might take time
51-
(cb) => setTimeout(cb, 100)
52-
], (err) => {
53-
if (err) { throw err }
54-
55-
//
56-
node1.peerRouting.findPeer(node3.peerInfo.id, (err, peer) => {
57-
if (err) { throw err }
58-
59-
console.log('Found it, multiaddrs are:')
60-
peer.multiaddrs.forEach((ma) => console.log(ma.toString()))
61-
})
62-
})
43+
await Promise.all([
44+
node1.dial(node2.peerInfo),
45+
node2.dial(node3.peerInfo)
46+
])
47+
48+
// Set up of the cons might take time
49+
await delay(100)
50+
51+
const peer = await node1.peerRouting.findPeer(node3.peerInfo.id)
52+
53+
console.log('Found it, multiaddrs are:')
54+
peer.multiaddrs.forEach((ma) => console.log(ma.toString()))
6355
```
6456

6557
You should see the output being something like:
@@ -82,17 +74,12 @@ You can find this example completed in [2.js](./2.js), however as you will see i
8274
Instead of calling `peerRouting.findPeer`, we will use `contentRouting.provide` and `contentRouting.findProviders`.
8375

8476
```JavaScript
85-
node1.contentRouting.provide(cid, (err) => {
86-
if (err) { throw err }
77+
await node1.contentRouting.provide(cid)
78+
console.log('Node %s is providing %s', node1.peerInfo.id.toB58String(), cid.toBaseEncodedString())
8779

88-
console.log('Node %s is providing %s', node1.peerInfo.id.toB58String(), cid.toBaseEncodedString())
80+
const provs = await all(node3.contentRouting.findProviders(cid, { timeout: 5000 }))
8981

90-
node3.contentRouting.findProviders(cid, 5000, (err, providers) => {
91-
if (err) { throw err }
92-
93-
console.log('Found provider:', providers[0].id.toB58String())
94-
})
95-
})
82+
console.log('Found provider:', providers[0].id.toB58String())
9683
```
9784

9885
The output of your program should look like:

0 commit comments

Comments
 (0)