feat: add UNL to get_network API

.vscode/settings.json

@@ -1,7 +1,9 @@
 {
     "editor.tabSize": 2,
     "cSpell.words": [
-      "secp256k1"
+        "combinator",
+        "secp256k1",
+        "unls"
     ],
     "[javascript]": {
         "editor.defaultFormatter": "esbenp.prettier-vscode",

src/api/routes/v1/get-network.ts

@@ -11,6 +11,11 @@ const log = logger({ name: 'api-get-network' })
 
 const CRAWL_PORTS = [51235, 2459, 30001]
 
+interface NetworkInfo {
+  network: string
+  unl?: string[]
+}
+
 let maxNetwork: number
 
 async function updateMaxNetwork(): Promise<void> {
@@ -119,6 +124,7 @@ async function any(
  */
 async function fetchCrawls(host: string): Promise<Crawl> {
   const promises: Array<Promise<Crawl | undefined>> = []
+  log.info(`crawling ${host}...`)
   for (const port of CRAWL_PORTS) {
     promises.push(crawlNode(host, port))
   }
@@ -132,11 +138,19 @@ async function fetchCrawls(host: string): Promise<Crawl> {
  * @param unl - The UNL of the node.
  * @returns Whether the UNL of the node has been seen before.
  */
-async function getNetworkFromUNL(unl: string): Promise<string | undefined> {
+async function getNetworkInfoFromUNL(
+  unl: string,
+): Promise<NetworkInfo | undefined> {
   const result = await query('networks')
-    .select('id')
+    .select('id', 'unls')
     .where('unls', 'like', `%${unl}%`)
-  return result.length > 0 ? result[0].id : undefined
+  if (result.length > 0) {
+    return {
+      network: result[0].id,
+      unl: result[0].unls.split(',')[0],
+    }
+  }
+  return undefined
 }
 
 /**
@@ -147,13 +161,20 @@ async function getNetworkFromUNL(unl: string): Promise<string | undefined> {
  * @returns The network associated with the public key of the node. Undefined
  * if the public key has not been seen by the network.
  */
-async function getNetworkFromPublicKey(
+async function getNetworkInfoFromPublicKey(
   publicKey: string,
-): Promise<string | undefined> {
+): Promise<NetworkInfo | undefined> {
   const result = await query('crawls')
     .select('public_key', 'networks')
     .where('public_key', '=', publicKey)
-  return result.length > 0 ? result[0].networks : undefined
+  const networkIds = result.length > 0 ? result[0].networks : undefined
+  if (networkIds == null) {
+    return networkIds
+  }
+  const networkResult = await query('networks')
+    .select('id', 'unls')
+    .whereIn('id', networkIds.split(','))
+  return networkResult
 }
 
 /**
@@ -173,6 +194,7 @@ async function addNode(url: string, unl: string | null): Promise<string> {
     port: 51235,
     unls: unl ? [unl] : [],
   }
+  log.info(`adding new network ${JSON.stringify(network)}`)
   await query('networks').insert({
     ...network,
     unls: network.unls.join(','),
@@ -204,23 +226,23 @@ export default async function getNetworkOrAdd(
     // check UNL
     const { node_unl } = crawl
     if (node_unl != null) {
-      const unlNetwork = await getNetworkFromUNL(node_unl)
+      const unlNetwork = await getNetworkInfoFromUNL(node_unl)
       // eslint-disable-next-line max-depth -- Necessary here
       if (unlNetwork != null) {
         return res.send({
           result: 'success',
-          network: unlNetwork,
+          ...unlNetwork,
         })
       }
     }
 
     // check if node public key is already recorded
     const { public_key } = crawl.this_node
-    const publicKeyNetwork = await getNetworkFromPublicKey(public_key)
+    const publicKeyNetwork = await getNetworkInfoFromPublicKey(public_key)
     if (publicKeyNetwork != null) {
       return res.send({
         result: 'success',
-        network: publicKeyNetwork,
+        ...publicKeyNetwork,
       })
     }
     // add node to networks list
@@ -229,6 +251,7 @@ export default async function getNetworkOrAdd(
     return res.send({
       result: 'success',
       network: newNetwork,
+      unl: node_unl,
     })
   } catch (err) {
     log.error(err.stack)

src/api/routes/v1/info.ts

@@ -6,6 +6,11 @@ const info = {
   documentation: 'Put Docs HERE',
   release_notes: 'Release Notes HERE',
   endpoints: [
+    {
+      action: 'Get Network From Node',
+      route: '/v1/network/get_network',
+      example: 'https://data.xrpl.org/v1/network/get_network',
+    },
     {
       action: 'Get Topology Nodes',
       route: '/v1/network/topology/nodes',