Merge pull request #623 from oceanprotocol/feature/add_getP2pNetworkStats_route

add getP2pNetworkStats route

Author: alexcos20

docs/env.md

@@ -69,6 +69,7 @@ Environmental variables are also tracked in `ENVIRONMENT_VARIABLES` within `src/
 - `P2P_AUTODIALCONCURRENCY`: When dialling peers from the peer book to keep the number of open connections, add dials for this many peers to the dial queue at once. Default: 5
 - `P2P_MAXPEERADDRSTODIAL`: Maximum number of addresses allowed for a given peer before giving up. Default: 5
 - `P2P_AUTODIALINTERVAL`: Auto dial interval (miliseconds). Amount of time between close and open of new peer connection. Default: 5000
+- `P2P_ENABLE_NETWORK_STATS`: Enables 'getP2pNetworkStats' http endpoint. Since this contains private informations (like your ip addresses), this is disabled by default
 
 ## Additional Nodes (Test Environments)
 

src/components/P2P/index.ts

@@ -436,6 +436,16 @@ export class OceanP2P extends EventEmitter {
     // }
   }
 
+  async getNetworkingStats() {
+    const ret: any = {}
+    ret.binds = await this._libp2p.components.addressManager.getListenAddrs()
+    ret.listen = await this._libp2p.components.transportManager.getAddrs()
+    ret.observing = await this._libp2p.components.addressManager.getObservedAddrs()
+    ret.announce = await this._libp2p.components.addressManager.getAnnounceAddrs()
+    ret.connections = await this._libp2p.getConnections()
+    return ret
+  }
+
   async getRunningOceanPeers() {
     return await this.getOceanPeers(true, false)
   }

src/components/httpRoutes/getOceanPeers.ts

@@ -2,9 +2,22 @@ import express, { Request, Response } from 'express'
 import { getDefaultLevel } from '../../utils/logging/Logger.js'
 import { P2P_LOGGER } from '../../utils/logging/common.js'
 import { hasP2PInterface, sendMissingP2PResponse } from './index.js'
-
+import { getBoolEnvValue } from '../../utils/config.js'
 export const getOceanPeersRoute = express.Router()
 
+getOceanPeersRoute.get(
+  '/getP2pNetworkStats',
+  async (req: Request, res: Response): Promise<void> => {
+    // only return values if env P2P_ENABLE_NETWORK_STATS is explicitly allowed
+    if (hasP2PInterface && getBoolEnvValue('P2P_ENABLE_NETWORK_STATS', false)) {
+      const stats = await req.oceanNode.getP2PNode().getNetworkingStats()
+      P2P_LOGGER.log(getDefaultLevel(), `getP2pNetworkStats: ${stats}`, true)
+      res.json(stats)
+    } else {
+      res.status(400).send('Not enabled or unavailable')
+    }
+  }
+)
 getOceanPeersRoute.get(
   '/getOceanPeers',
   async (req: Request, res: Response): Promise<void> => {

src/utils/config.ts

@@ -57,7 +57,7 @@ function getIntEnvValue(env: any, defaultValue: number) {
   return isNaN(num) ? defaultValue : num
 }
 
-function getBoolEnvValue(envName: string, defaultValue: boolean): boolean {
+export function getBoolEnvValue(envName: string, defaultValue: boolean): boolean {
   if (!(envName in process.env)) {
     return defaultValue
   }