feat(cli): enhance listpeers output

Co-authored-by: ImmanuelSegol <3ditds@gmail.com>

Author: 2 people

lib/cli/commands/listpeers.ts

@@ -1,11 +1,85 @@
-import { callback, loadXudClient } from '../command';
+import Table, { HorizontalTable } from 'cli-table3';
+import colors from 'colors/safe';
 import { Arguments } from 'yargs';
-import { ListPeersRequest } from '../../proto/xudrpc_pb';
+import { ListPeersRequest, ListPeersResponse, Peer } from '../../proto/xudrpc_pb';
+import { callback, loadXudClient } from '../command';
+import { generateHeaders } from '../utils';
+
+const HEADERS = [
+  'Peer',
+  'Pairs',
+  'Details',
+];
+
+const createTable = () => {
+  const table = new Table({
+    head: generateHeaders(HEADERS),
+  }) as HorizontalTable;
+  return table;
+};
+
+const trimPubKey = (key: string) => {
+  if (key.length <= 0) {
+    return '';
+  }
+  return `${key.slice(0, 10)}...${key.slice(key.length - 10)}`;
+};
+
+const formatPairList = (pairs: string[]) => {
+  let pairString = '';
+  pairs.forEach((pair) => {
+    /* eslint disable-next-line */
+    pairString = `${pairString}${pairString ? '\n' : ''}${pair}`;
+  });
+  return pairString;
+};
+
+const formatLndPubKeys = (lndKeys: string[][]) => {
+  let str = '';
+  lndKeys.forEach((client) => {
+    /* eslint disable-next-line */
+    str =  `${str}${str ? '\n' : ''}${client[0]} lnd key: ${trimPubKey(client[1])}`;
+  });
+  return str;
+};
+
+const formatPeers = (peers: ListPeersResponse.AsObject) => {
+  const formattedPeers: string[][] = [];
+  peers.peersList.forEach((peer: Peer.AsObject) => {
+
+    const address = `${peer.nodePubKey}
+@${peer.address}` ;
+
+    const details = [
+      `Alias:
+
+Address ([node_key]@[host]:[port]):
+${address}`,
+      formatPairList(peer.pairsList),
+      `inbound: ${peer.inbound}\
+\nversion: ${peer.xudVersion}\
+\ntime connected: ${peer.secondsConnected.toString()} seconds\
+\n${formatLndPubKeys(peer.lndPubKeysMap)}\
+${peer.raidenAddress ? `\nraiden address: ${trimPubKey(peer.raidenAddress)}` : ''}`,
+    ];
+    formattedPeers.push(details);
+  });
+  return formattedPeers;
+};
+
+const displayTables = (peers: ListPeersResponse.AsObject) => {
+  const table = createTable();
+  formatPeers(peers).forEach((peer) => {
+    table.push(peer);
+  });
+  console.log(colors.underline(colors.bold('\nPeers:')));
+  console.log(table.toString());
+};
 
 export const command = 'listpeers';
 
 export const describe = 'list connected peers';
 
 export const handler = (argv: Arguments) => {
-  loadXudClient(argv).listPeers(new ListPeersRequest(), callback(argv));
+  loadXudClient(argv).listPeers(new ListPeersRequest(), callback(argv, displayTables));
 };

lib/cli/utils.ts

@@ -1,3 +1,4 @@
+import colors from 'colors/safe';
 import os from 'os';
 import path from 'path';
 
@@ -20,6 +21,12 @@ export function getDefaultCertPath() {
   }
 }
 
+export const generateHeaders = (headers: string[]) => {
+  return headers.map((header) => {
+    return colors.blue(header);
+  });
+};
+
 /** Returns a number of coins as an integer number of satoshis. */
 export const coinsToSats = (coinsQuantity: number) => {
   return Math.round(coinsQuantity * SATOSHIS_PER_COIN);