helia-coord 1.8.0 → 1.9.0

package/README.md

@@ -3,3 +3,7 @@
 This is a fork of [ipfs-coord-esm](https://github.com/Permissionless-Software-Foundation/ipfs-coord-esm), adpted for use with [Helia](https://github.com/ipfs/helia) instead of Kubo.
 
 Read the [dev-docs](./dev-docs) for more information.
+
+## Node Version
+
+Use node.js v22

package/lib/adapters/gist.js

@@ -62,7 +62,7 @@ class Gist {
 
       // Retrieve the gist from github.com.
       const result = await this.axios.get(gistUrl)
-      console.log('result.data: ', result.data)
+      // console.log('result.data: ', result.data)
 
       // Get the current content of the gist.
       const content = result.data

package/lib/adapters/pubsub-adapter/messaging.js

@@ -129,7 +129,7 @@ class Messaging {
       if (!decryptedPayload) {
         return false
       }
-      this.log.statusLog(2, 'decrypted payload:', decryptedPayload)
+      this.log.statusLog(3, 'decrypted payload:', decryptedPayload)
 
       // Filter ACK messages from other messages
       if (decryptedPayload.includes('"apiName":"ACK"')) {

package/lib/use-cases/relay-use-cases.js

@@ -145,7 +145,7 @@ class RelayUseCases {
       // Loop through each relay.
       for (let i = 0; i < knownRelays.length; i++) {
         const thisRelay = knownRelays[i]
-        // console.log('thisRelay: ', thisRelay)
+        console.log('thisRelay: ', thisRelay)
 
         // Get connected peers
         const connectedPeers = await this.adapters.ipfs.getPeers()
@@ -153,7 +153,7 @@ class RelayUseCases {
 
         // Check if target circuit-relay is currently conected to the node.
         const connectedPeer = connectedPeers.filter(peerId => thisRelay.ipfsId.includes(peerId))
-        // console.log('connectedPeer: ', connectedPeer)
+        console.log('connectedPeer: ', connectedPeer)
 
         // Get the peer data corresponding to this relay
         // let peerData = thisNode.peerData.filter(x => x.from.includes(thisRelay.ipfsId))
@@ -192,14 +192,17 @@ class RelayUseCases {
             thisNode.peerData[peerIndex].data.connectionAddr = remoteConnection[0].remoteAddr.toString()
           }
 
-          // console.log(`Multiaddr changed to ${thisRelay.multiaddr}`)
+          console.log(`Multiaddr changed to ${thisRelay.multiaddr}`)
 
           // Debugging: log situations when the relay is connected through
           // another circuit relay.
           if (thisRelay.multiaddr.includes('/p2p-circuit')) {
             for (const connection of libp2p.getConnections()) {
-              console.log('DEBUG: connection.remoteAddr: ', connection.remoteAddr.toString())
               // Logs the PeerId string and the observed remote multiaddr of each Connection
+              this.adapters.log.statusLog(
+                2,
+                `DEBUG: connection.remoteAddr: ${connection.remoteAddr.toString()}`
+              )
             }
           }
         } else {
@@ -213,11 +216,12 @@ class RelayUseCases {
             { multiaddr: thisRelay.multiaddr }
           )
           thisRelay.connected = connStatus.success
-          // console.log(`thisRelay.connected: ${thisRelay.connected}`)
+          console.log(`thisRelay.connected: ${thisRelay.connected}`)
 
           // Debugging: Trying to figure out the best way to select the multiaddr
           console.log('relay multiaddr: ', thisRelay.multiaddr)
           if (thisRelay.connected && !thisRelay.multiaddr.includes('/tcp/')) {
+            // 2/25/25 CT: Have not seen this code path executed in a long time.
             console.log('DEBUG: thisRelay.multiaddr: ', thisRelay.multiaddr)
 
             const libp2p = this.adapters.ipfs.ipfs.libp2p
@@ -476,12 +480,8 @@ class RelayUseCases {
 
         // Get the peer data.
         let peerData = thisNode.peerData.filter(x => {
-          if (!x.data) {
-            console.log('broken peer data: ', x)
-            return false
-          }
-          // console.log(`x.data.ipfsId: ${x.data.ipfsId}`)
-          // console.log(`thisRelay.ipfsId: ${thisRelay.ipfsId}`)
+          // Skip entries with null or missing data
+          if (!x.data) return false
           return x.data.ipfsId === thisRelay.ipfsId
         })
         peerData = peerData[0]
@@ -524,6 +524,8 @@ class RelayUseCases {
         // Save the new metric value.
         thisRelay.metrics.aboutLatency.push(diffTime)
       }
+
+      return true
     } catch (err) {
       console.error('Error in measureRelays(): ', err)
       throw err

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "helia-coord",
-  "version": "1.8.0",
+  "version": "1.9.0",
   "description": "A JS library for helping IPFS peers coordinate, find a common interest, and stay connected around that interest.",
   "main": "./index.js",
   "type": "module",
@@ -21,16 +21,16 @@
   "homepage": "https://github.com/Permissionless-Software-Foundation/helia-coord#readme",
   "devDependencies": {
     "@chainsafe/libp2p-gossipsub": "14.1.0",
-    "@chainsafe/libp2p-noise": "16.0.1",
-    "@chainsafe/libp2p-yamux": "7.0.1",
+    "@chainsafe/libp2p-noise": "17.0.0",
+    "@chainsafe/libp2p-yamux": "8.0.1",
     "@istanbuljs/esm-loader-hook": "0.2.0",
     "@libp2p/circuit-relay-v2": "3.2.2",
     "@libp2p/identify": "3.0.22",
     "@libp2p/ping": "2.0.22",
-    "@libp2p/tcp": "10.1.2",
+    "@libp2p/tcp": "11.0.10",
     "@libp2p/webrtc": "5.2.2",
-    "@libp2p/websockets": "9.2.2",
-    "@multiformats/multiaddr": "12.3.5",
+    "@libp2p/websockets": "10.1.3",
+    "@multiformats/multiaddr": "13.0.1",
     "@multiformats/multiaddr-matcher": "1.6.0",
     "blockstore-fs": "2.0.2",
     "chai": "4.3.6",
@@ -39,7 +39,7 @@
     "delay": "6.0.0",
     "helia": "5.2.1",
     "lodash.clonedeep": "4.5.0",
-    "minimal-slp-wallet": "5.12.0",
+    "minimal-slp-wallet": "7.1.4",
     "mocha": "10.0.0",
     "nyc": "15.1.0",
     "public-ip": "6.0.1",
@@ -52,7 +52,7 @@
     "uuid": "9.0.0"
   },
   "peerDependencies": {
-    "libp2p": ">=2.6.0"
+    "libp2p": ">=3.1.3"
   },
   "exports": {
     ".": {

package/test/unit/adapters/encryption-adapter-unit.js

@@ -166,6 +166,17 @@ describe('#Adapters - Encryption', () => {
       }
     })
 
+    it('should throw and error if peer public key is not available', async () => {
+      try {
+        const peer = {}
+        await uut.encryptMsg(peer, 'testMsg')
+
+        assert.fail('Unexpected code path')
+      } catch (err) {
+        assert.include(err.message, 'Peer public key is not available yet.')
+      }
+    })
+
     it('should encrypt a string', async () => {
       // Mock dependencies
       sandbox

package/test/unit/adapters/gist.unit.adapters.js

@@ -55,6 +55,7 @@ describe('#Adapter-Gist', () => {
       }
     })
   })
+
   describe('#getCRList2', () => {
     it('should get data from GitHub', async () => {
       // Mock network dependencies

package/test/unit/adapters/pubsub/messaging-adapter-unit.js

@@ -14,13 +14,14 @@ import ipfsLib from '../../../mocks/ipfs-mock.js'
 import IPFSAdapter from '../../../../lib/adapters/ipfs-adapter.js'
 import EncryptionAdapter from '../../../../lib/adapters/encryption-adapter.js'
 import BchAdapter from '../../../../lib/adapters/bch-adapter.js'
-import thisNode from '../../../mocks/thisnode-mocks.js'
+import thisNodeMock from '../../../mocks/thisnode-mocks.js'
 import ResendMsg from '../../../../lib/adapters/pubsub-adapter/resend-msg.js'
 
 describe('#messaging-adapter', () => {
   let sandbox
   let uut
   let ipfs, ipfsAdapter
+  let thisNode
 
   const log = {
     statusLog: () => {}
@@ -34,6 +35,8 @@ describe('#messaging-adapter', () => {
     ipfs = cloneDeep(ipfsLib)
     ipfsAdapter = new IPFSAdapter({ ipfs, log })
 
+    thisNode = cloneDeep(thisNodeMock)
+
     // Instantiate the Encryption adapater
     const wallet = new SlpWallet()
     await wallet.walletInfoPromise
@@ -165,33 +168,53 @@ describe('#messaging-adapter', () => {
       assert.property(result, 'receiver')
       assert.property(result, 'payload')
     })
-  })
-  it('should throws error if sender is not found', async () => {
-    try {
-      const ipfsId = 'unknowPeerId'
-      const data = {
-        sender: ipfsId,
-        uuid: 'fake-uuid'
+
+    it('should throws error if sender is not found', async () => {
+      try {
+        const ipfsId = 'unknowPeerId'
+        const data = {
+          sender: ipfsId,
+          uuid: 'fake-uuid'
+        }
+
+        await uut.generateAckMsg(data, thisNode)
+
+        assert.fail('Unexpected code path')
+      } catch (err) {
+        console.log(err)
+        assert.include(err.message, 'Required encryption information for peer is not available.')
       }
+    })
 
-      await uut.generateAckMsg(data, thisNode)
+    it('should catch and throw errors', async () => {
+      try {
+        await uut.generateAckMsg()
 
-      assert.fail('Unexpected code path')
-    } catch (err) {
-      console.log(err)
-      assert.include(err.message, 'Required encryption information for peer is not available.')
-    }
-  })
+        assert.fail('Unexpected code path')
+      } catch (err) {
+        console.log(err)
+        assert.include(err.message, 'Cannot read')
+      }
+    })
 
-  it('should catch and throw errors', async () => {
-    try {
-      await uut.generateAckMsg()
+    it('should throw an error if peerData is not specified', async () => {
+      try {
+        const ipfsId = '12D3KooWHS5A6Ey4V8fLWD64jpPn2EKi4r4btGN6FfkNgMTnfqVa'
+        const data = {
+          sender: ipfsId,
+          uuid: 'fake-uuid'
+        }
+
+        thisNode.peerData = []
+
+        const result = await uut.generateAckMsg(data, thisNode)
+        console.log(result)
 
-      assert.fail('Unexpected code path')
-    } catch (err) {
-      console.log(err)
-      assert.include(err.message, 'Cannot read')
-    }
+        assert.fail('Unexpected code path')
+      } catch (err) {
+        assert.include(err.message, 'Required encryption information for peer is not available.')
+      }
+    })
   })
 
   describe('#publishToPubsubChannel', () => {

package/test/unit/controllers/pubsub-controller.unit.js

@@ -106,11 +106,12 @@ describe('#Pubsub-Controller', () => {
       assert.equal(result, false)
     })
   })
-  describe('#coinjoinPubsubHandler (default)', () => {
-    it('should return true', async () => {
-      const result = await uut.coinjoinPubsubHandler()
 
-      assert.isTrue(result)
+  describe('#coinjoinPubsubHandler', () => {
+    it('should always return true', () => {
+      const result = uut.coinjoinPubsubHandler()
+
+      assert.equal(result, true)
     })
   })
 })

package/test/unit/use-cases/relay-use-cases-unit.js

@@ -298,6 +298,85 @@ describe('#relay-Use-Cases', () => {
 
       assert.equal(result, false)
     })
+
+    it('Should log when CR is connected through another CR, and does not have a tcp transport', async () => {
+      // Force relay data to have a p2p-circuit multiaddr
+      // mockData.mockRelayData[0].multiaddr = '/ip4/116.203.193.74/tcp/4001/ipfs/QmNZktxkfScScnHCFSGKELH3YRqdxHQ3Le9rAoRLhZ6vgL'
+      mockData.mockRelayData[0].multiaddr = '/ip4/116.203.193.74/udp/4001/ipfs/QmNZktxkfScScnHCFSGKELH3YRqdxHQ3Le9rAoRLhZ6vgL/p2p-circuit/p2p/QmNZktxkfScScnHCFSGKELH3YRqdxHQ3Le9rAoRLhZ6vgL'
+
+      // Force circuit relay to be used.
+      thisNode.relayData = mockData.mockRelayData
+
+      // Force mock circuit relay to appear as being already connected.
+      mockData.connectedPeerList01.push(mockData.mockRelayData[0].ipfsId)
+
+      // Force entity data with implicit multiaddr, which will will overwrite
+      // the explicit multiaddr provided by the realy.
+      thisNode.peerData.push({
+        from: 'QmNZktxkfScScnHCFSGKELH3YRqdxHQ3Le9rAoRLhZ6vgL',
+        data: {
+          connectionAddr: 'fake-multiaddr'
+        }
+      })
+
+      // Mock dependencies
+      sandbox.stub(uut, 'sortRelays').returns(thisNode.relayData)
+      sandbox.stub(uut.adapters.ipfs, 'getPeers').resolves(mockData.connectedPeerList01)
+      sandbox.stub(uut.adapters.ipfs.ipfs.libp2p, 'getConnections').returns([{
+        remoteAddr: '/ip4/116.203.193.74/udp/4001/ipfs/QmNZktxkfScScnHCFSGKELH3YRqdxHQ3Le9rAoRLhZ6vgL/p2p-circuit/p2p/QmNZktxkfScScnHCFSGKELH3YRqdxHQ3Le9rAoRLhZ6vgL'
+      }])
+
+      // uut.state.relays = crMockData.circuitRelays
+      const result = await uut.connectToCRs(thisNode)
+
+      console.log('thisNode.peerData: ', thisNode.peerData)
+
+      // Assert function executed successfully.
+      assert.equal(result, true)
+
+      // Assert that the multiaddr was overwritten
+      // assert.include(thisNode.peerData[0].data.connectionAddr, 'tcp')
+    })
+
+    it('Should log when CR makes a new connection through another CR, and does not have a tcp transport', async () => {
+      // Force relay data to have a p2p-circuit multiaddr
+      // mockData.mockRelayData[0].multiaddr = '/ip4/116.203.193.74/tcp/4001/ipfs/QmNZktxkfScScnHCFSGKELH3YRqdxHQ3Le9rAoRLhZ6vgL'
+      mockData.mockRelayData[0].multiaddr = '/ip4/116.203.193.74/udp/4001/ipfs/QmNZktxkfScScnHCFSGKELH3YRqdxHQ3Le9rAoRLhZ6vgL/p2p-circuit/p2p/QmNZktxkfScScnHCFSGKELH3YRqdxHQ3Le9rAoRLhZ6vgL'
+
+      // Force circuit relay to be used.
+      thisNode.relayData = mockData.mockRelayData
+
+      // Force mock circuit relay to appear as being already connected.
+      // mockData.connectedPeerList01.push(mockData.mockRelayData[0].ipfsId)
+
+      // Force entity data with implicit multiaddr, which will will overwrite
+      // the explicit multiaddr provided by the realy.
+      thisNode.peerData.push({
+        from: 'QmNZktxkfScScnHCFSGKELH3YRqdxHQ3Le9rAoRLhZ6vgL',
+        data: {
+          connectionAddr: 'fake-multiaddr'
+        }
+      })
+
+      // Mock dependencies
+      sandbox.stub(uut, 'sortRelays').returns(thisNode.relayData)
+      sandbox.stub(uut.adapters.ipfs, 'getPeers').resolves(mockData.connectedPeerList01)
+      sandbox.stub(uut.adapters.ipfs.ipfs.libp2p, 'getConnections').returns([{
+        remoteAddr: '/ip4/116.203.193.74/udp/4001/ipfs/QmNZktxkfScScnHCFSGKELH3YRqdxHQ3Le9rAoRLhZ6vgL/p2p-circuit/p2p/QmNZktxkfScScnHCFSGKELH3YRqdxHQ3Le9rAoRLhZ6vgL'
+      }])
+      sandbox.stub(uut.adapters.ipfs, 'connectToPeer').resolves({ success: true })
+
+      // uut.state.relays = crMockData.circuitRelays
+      const result = await uut.connectToCRs(thisNode)
+
+      console.log('thisNode.peerData: ', thisNode.peerData)
+
+      // Assert function executed successfully.
+      assert.equal(result, true)
+
+      // Assert that the multiaddr was overwritten
+      // assert.include(thisNode.peerData[0].data.connectionAddr, 'tcp')
+    })
   })
 
   describe('#addRelay', () => {