Merge pull request #132 from Permissionless-Software-Foundation/v0.46.21

Updated to helia-coord v1.4.1

package.json

@@ -28,8 +28,6 @@
     "@chainsafe/libp2p-noise": "14.1.0",
     "@chainsafe/libp2p-yamux": "6.0.1",
     "@libp2p/bootstrap": "10.0.7",
-    "@libp2p/circuit-relay-v2": "1.0.7",
-    "@libp2p/identify": "1.0.6",
     "@libp2p/tcp": "9.0.7",
     "axios": "0.27.2",
     "bcryptjs": "2.4.3",
@@ -37,7 +35,7 @@
     "datastore-fs": "9.1.6",
     "glob": "7.1.6",
     "helia": "2.1.0",
-    "helia-coord": "1.2.24",
+    "helia-coord": "1.4.1",
     "jsonrpc-lite": "2.2.0",
     "jsonwebtoken": "8.5.1",
     "jwt-bch-lib": "1.3.0",
@@ -52,14 +50,14 @@
     "koa-router": "10.0.0",
     "koa-static": "5.0.0",
     "koa2-ratelimit": "0.9.1",
-    "libp2p": "1.0.10",
+    "libp2p": "0.46.21",
     "line-reader": "0.4.0",
     "minimal-slp-wallet": "5.11.1",
     "mongoose": "5.13.14",
     "node-fetch": "npm:@achingbrain/node-fetch@2.6.7",
     "nodemailer": "6.7.5",
     "passport-local": "1.0.0",
-    "public-ip": "4.0.4",
+    "public-ip": "6.0.1",
     "winston": "3.3.3",
     "winston-daily-rotate-file": "4.5.0"
   },

src/adapters/ipfs/ipfs-coord.js

@@ -10,7 +10,7 @@ import IpfsCoord from 'helia-coord'
 
 // import BCHJS from '@psf/bch-js';
 import SlpWallet from 'minimal-slp-wallet'
-import publicIp from 'public-ip'
+import { publicIpv4 } from 'public-ip'
 
 // Local libraries
 import config from '../../../config/index.js'
@@ -35,7 +35,7 @@ class IpfsCoordAdapter {
     // this.bchjs = new BCHJS()
     this.wallet = new SlpWallet()
     this.config = config
-    this.publicIp = publicIp
+    this.publicIp = publicIpv4
 
     // Properties of this class instance.
     this.isReady = false
@@ -52,7 +52,7 @@ class IpfsCoordAdapter {
     // If configured as a Circuit Relay, get the public IP addresses for this node.
     if (this.config.isCircuitRelay) {
       try {
-        const ip4 = await this.publicIp.v4()
+        const ip4 = await this.publicIp()
         // const ip6 = await publicIp.v6()
 
         circuitRelayInfo.ip4 = ip4

src/adapters/ipfs/ipfs.js

@@ -18,12 +18,13 @@ import { tcp } from '@libp2p/tcp'
 import { noise } from '@chainsafe/libp2p-noise'
 import { yamux } from '@chainsafe/libp2p-yamux'
 // import { bootstrap } from '@libp2p/bootstrap'
-import { identify } from '@libp2p/identify'
-// import { circuitRelayServer, circuitRelayTransport } from 'libp2p/circuit-relay'
-import { circuitRelayServer, circuitRelayTransport } from '@libp2p/circuit-relay-v2'
+import { identifyService } from 'libp2p/identify'
+// import { identify } from '@libp2p/identify'
+import { circuitRelayServer, circuitRelayTransport } from 'libp2p/circuit-relay'
+// import { circuitRelayServer, circuitRelayTransport } from '@libp2p/circuit-relay-v2'
 import { gossipsub } from '@chainsafe/libp2p-gossipsub'
 import { webSockets } from '@libp2p/websockets'
-import publicIp from 'public-ip'
+import { publicIpv4 } from 'public-ip'
 import { multiaddr } from '@multiformats/multiaddr'
 import { webRTC } from '@libp2p/webrtc'
 
@@ -45,7 +46,7 @@ class IpfsAdapter {
     this.config = config
     this.fs = fs
     this.createLibp2p = createLibp2p
-    this.publicIp = publicIp
+    this.publicIp = publicIpv4
     this.multiaddr = multiaddr
 
     // Properties of this class instance.
@@ -72,7 +73,7 @@ class IpfsAdapter {
       console.log('IPFS ID: ', this.id)
 
       // Attempt to guess our ip4 IP address.
-      const ip4 = await this.publicIp.v4()
+      const ip4 = await this.publicIp()
       let detectedMultiaddr = `/ip4/${ip4}/tcp/${this.config.ipfsTcpPort}/p2p/${this.id}`
       detectedMultiaddr = this.multiaddr(detectedMultiaddr)
 
@@ -111,12 +112,24 @@ class IpfsAdapter {
 
       // Configure services
       const services = {
-        identify: identify(),
+        identify: identifyService(),
         pubsub: gossipsub({ allowPublishToZeroPeers: true })
       }
       if (this.config.isCircuitRelay) {
         console.log('Helia (IPFS) node IS configured as Circuit Relay')
-        services.relay = circuitRelayServer()
+        services.relay = circuitRelayServer({ // makes the node function as a relay server
+          hopTimeout: 30 * 1000, // incoming relay requests must be resolved within this time limit
+          advertise: true,
+          reservations: {
+            maxReservations: 15, // how many peers are allowed to reserve relay slots on this server
+            reservationClearInterval: 300 * 1000, // how often to reclaim stale reservations
+            applyDefaultLimit: true, // whether to apply default data/duration limits to each relayed connection
+            defaultDurationLimit: 2 * 60 * 1000, // the default maximum amount of time a relayed connection can be open for
+            defaultDataLimit: BigInt(2 << 7), // the default maximum number of bytes that can be transferred over a relayed connection
+            maxInboundHopStreams: 32, // how many inbound HOP streams are allow simultaneously
+            maxOutboundHopStreams: 64 // how many outbound HOP streams are allow simultaneously
+          }
+        })
       } else {
         console.log('Helia (IPFS) node IS NOT configured as Circuit Relay')
       }
@@ -158,7 +171,10 @@ class IpfsAdapter {
         transports: [
           tcp(),
           webSockets(),
-          circuitRelayTransport({ discoverRelays: 3 }),
+          circuitRelayTransport({
+            discoverRelays: 3,
+            reservationConcurrency: 3
+          }),
           webRTC()
         ],
         connectionEncryption: [

src/controllers/rest-api/ipfs/controller.js

@@ -30,6 +30,7 @@ class IpfsRESTControllerLib {
     this.getRelays = this.getRelays.bind(this)
     this.handleError = this.handleError.bind(this)
     this.connect = this.connect.bind(this)
+    this.getThisNode = this.getThisNode.bind(this)
   }
 
   /**
@@ -99,6 +100,29 @@ class IpfsRESTControllerLib {
     }
   }
 
+  /**
+   * @api {get} /ipfs/node Get a copy of the thisNode object from helia-coord
+   * @apiPermission public
+   * @apiName GetThisNode
+   * @apiGroup REST BCH
+   *
+   * @apiExample Example usage:
+   * curl -H "Content-Type: application/json" -X GET localhost:5001/ipfs/node
+   *
+   */
+  async getThisNode (ctx) {
+    try {
+      // const status = await this.adapters.ipfs.getStatus()
+      const thisNode = this.adapters.ipfs.ipfsCoordAdapter.ipfsCoord.thisNode
+
+      ctx.body = { thisNode }
+    } catch (err) {
+      wlogger.error('Error in ipfs/controller.js/getThisNode(): ')
+      // ctx.throw(422, err.message)
+      this.handleError(ctx, err)
+    }
+  }
+
   // DRY error handler
   handleError (ctx, err) {
     // If an HTTP status is specified by the buisiness logic, use that.

src/controllers/rest-api/ipfs/index.js

@@ -55,6 +55,7 @@ class IpfsRouter {
     this.router.post('/peers', this.ipfsRESTController.getPeers)
     this.router.post('/relays', this.ipfsRESTController.getRelays)
     this.router.post('/connect', this.ipfsRESTController.connect)
+    this.router.get('/node', this.ipfsRESTController.getThisNode)
 
     // Attach the Controller routes to the Koa app.
     app.use(this.router.routes())

test/unit/adapters/ipfs-coord.adapter.unit.js

@@ -52,7 +52,7 @@ describe('#IPFS', () => {
     it('should get the public IP address if this node is a Circuit Relay', async () => {
       // Mock dependencies.
       uut.IpfsCoord = IPFSCoordMock
-      sandbox.stub(uut.publicIp, 'v4').resolves('123')
+      sandbox.stub(uut, 'publicIp').resolves('123')
 
       // Force Circuit Relay
       uut.config.isCircuitRelay = true
@@ -66,7 +66,7 @@ describe('#IPFS', () => {
     it('should exit quietly if this node is a Circuit Relay and there is an issue getting the IP address', async () => {
       // Mock dependencies.
       uut.IpfsCoord = IPFSCoordMock
-      sandbox.stub(uut.publicIp, 'v4').rejects(new Error('test error'))
+      sandbox.stub(uut, 'publicIp').rejects(new Error('test error'))
 
       // Force Circuit Relay
       uut.config.isCircuitRelay = true

test/unit/adapters/ipfs.adapter.unit.js

@@ -53,7 +53,7 @@ describe('#IPFS-adapter', () => {
     it('should return a promise that resolves into an instance of IPFS.', async () => {
       // Mock dependencies.
       sandbox.stub(uut, 'createNode').resolves(ipfs)
-      sandbox.stub(uut.publicIp, 'v4').resolves('192.168.2.4')
+      sandbox.stub(uut, 'publicIp').resolves('192.168.2.4')
       sandbox.stub(uut, 'multiaddr').returns('/ip4/fake-multiaddr')
 
       const result = await uut.start()