refactor: examples/pnet (#523)

* refactor: examples/pnet

* chore: rename pnet-ipfs to pnet

* chore: address review

Author: vasco-santos

examples/pnet-ipfs/index.js

@@ -1,5 +1,5 @@
-# Private Networking with IPFS
-This example shows how to set up a private network of IPFS nodes.
+# Private Networking
+This example shows how to set up a private network of libp2p nodes.
 
 ## Setup
 Install dependencies:

examples/pnet-ipfs/libp2p-bundle.js

@@ -0,0 +1,50 @@
+/* eslint no-console: ["off"] */
+'use strict'
+
+const { generate } = require('libp2p/src/pnet')
+const privateLibp2pNode = require('./libp2p-node')
+
+const pipe = require('it-pipe')
+
+// Create a buffer and write the swarm key to it
+const swarmKey = Buffer.alloc(95)
+generate(swarmKey)
+
+// This key is for testing a different key not working
+const otherSwarmKey = Buffer.alloc(95)
+generate(otherSwarmKey)
+
+;(async () => {
+  const node1 = await privateLibp2pNode(swarmKey)
+
+  // TASK: switch the commented out line below so we're using a different key, to see the nodes fail to connect	
+  const node2 = await privateLibp2pNode(swarmKey)
+  // const node2 = await privateLibp2pNode(otherSwarmKey)
+
+  await Promise.all([
+    node1.start(),
+    node2.start()
+  ])
+
+  console.log('nodes started...')
+
+  await node1.dial(node2.peerInfo)
+
+  node2.handle('/private', ({ stream }) => {
+    pipe(
+      stream,
+      async function (source) {
+        for await (const msg of source) {
+          console.log(msg.toString())
+        }
+      }
+    )
+  })
+
+  const { stream } = await node1.dialProtocol(node2.peerInfo, '/private')
+
+  await pipe(
+    ['This message is sent on a private network'],
+    stream
+  )
+})();

examples/pnet-ipfs/.gitignore renamed to examples/pnet/.gitignore

@@ -0,0 +1,36 @@
+'use strict'
+
+const Libp2p = require('libp2p')
+const TCP = require('libp2p-tcp')
+const MPLEX = require('libp2p-mplex')
+const SECIO = require('libp2p-secio')
+const Protector = require('libp2p/src/pnet')
+
+/**
+ * privateLibp2pNode returns a libp2p node function that will use the swarm
+ * key at the given `swarmKeyPath` to create the Protector
+ *
+ * @param {Buffer} swarmKey
+ * @returns {Promise<libp2p>} Returns a libp2pNode function for use in IPFS creation
+ */
+const privateLibp2pNode = async (swarmKeyPath) => {
+  const node = await Libp2p.create({
+    modules: {
+      transport: [TCP], // We're only using the TCP transport for this example
+      streamMuxer: [MPLEX], // We're only using mplex muxing
+      // Let's make sure to use identifying crypto in our pnet since the protector doesn't
+      // care about node identity, and only the presence of private keys
+      connEncryption: [SECIO],
+      // Leave peer discovery empty, we don't want to find peers. We could omit the property, but it's
+      // being left in for explicit readability.
+      // We should explicitly dial pnet peers, or use a custom discovery service for finding nodes in our pnet
+      peerDiscovery: [],
+      connProtector: new Protector(swarmKeyPath)
+    }
+  })
+
+  node.peerInfo.multiaddrs.add('/ip4/0.0.0.0/tcp/0')
+  return node
+}
+
+module.exports = privateLibp2pNode

examples/pnet-ipfs/README.md renamed to examples/pnet/README.md

@@ -11,10 +11,9 @@
   "author": "",
   "license": "ISC",
   "dependencies": {
-    "ipfs": "^0.38.0",
-    "libp2p": "^0.26.2",
-    "libp2p-mplex": "^0.8.5",
-    "libp2p-secio": "^0.11.1",
-    "libp2p-tcp": "^0.13.2"
+    "libp2p": "../..",
+    "libp2p-mplex": "^0.9.3",
+    "libp2p-secio": "^0.12.1",
+    "libp2p-tcp": "^0.14.2"
   }
 }