Expose node ports in API

Author: Relfos

Phantasma.API/NexusAPI.cs

@@ -404,6 +404,7 @@ public class NexusAPI
         public ITokenSwapper TokenSwapper;
         public Mempool Mempool;
         public Node Node;
+
         public IEnumerable<APIEntry> Methods => _methods.Values;
 
         private readonly Dictionary<string, APIEntry> _methods = new Dictionary<string, APIEntry>(StringComparer.InvariantCultureIgnoreCase);
@@ -2126,9 +2127,22 @@ public IAPIResult GetPeers()
                 allPeers = allPeers.Where(x => !x.Endpoint.Host.Contains("localhost"));
             }
 
-            var peers = allPeers.Select(x => new PeerResult() { url = x.Endpoint.ToString(), version = x.Version, flags = x.Capabilities.ToString(), fee = x.MinimumFee.ToString(), pow = (uint)x.MinimumPoW }).ToList();
-
-            peers.Add(new PeerResult() { url = $"{Node.PublicEndpoint}", version = Node.Version, flags = Node.Capabilities.ToString(), fee = Node.MinimumFee.ToString(), pow = (uint)Node.MinimumPoW });
+            var peers = allPeers.Select(x => new PeerResult() { 
+                url = x.Endpoint.ToString(), 
+                version = x.Version, 
+                flags = x.Capabilities.ToString(), 
+                fee = x.MinimumFee.ToString(), 
+                pow = (uint)x.MinimumPoW, 
+                ports = x.Ports.Select(y => new PortResult() { name = y.Name, port = y.Port}).ToArray() 
+            }) .ToList();
+
+            peers.Add(new PeerResult() { 
+                url = $"{Node.PublicEndpoint}", 
+                version = Node.Version, 
+                flags = Node.Capabilities.ToString(), 
+                fee = Node.MinimumFee.ToString(), 
+                pow = (uint)Node.MinimumPoW, 
+                ports = this.Node.AvailablePorts.Select(y => new PortResult() { name = y.Name, port = y.Port }).ToArray() });
 
             peers.Shuffle();
 

Phantasma.API/Structs.cs

@@ -592,6 +592,15 @@ public struct ReceiptResult : IAPIResult
         public string script;
     }
 
+    public struct PortResult: IAPIResult
+    {
+        [APIDescription("Port description")]
+        public string name;
+
+        [APIDescription("Port number")]
+        public int port;
+    }
+
     public struct PeerResult: IAPIResult
     {
         [APIDescription("URL of peer")]
@@ -608,6 +617,9 @@ public struct PeerResult: IAPIResult
 
         [APIDescription("Minimum proof of work required by node")]
         public uint pow;
+
+        [APIDescription("List of exposed ports")]
+        public PortResult[] ports;
     }
 
     public struct ValidatorResult : IAPIResult

Phantasma.P2P/Messages/ListMessage.cs

@@ -39,6 +39,15 @@ public static ChainInfo Unserialize(BinaryReader reader)
         }
     }
 
+    public class PeerInfo
+    {
+        public string version;
+        public PeerCaps caps;
+        public BigInteger minimumFee;
+        public uint minimumPow;
+        public PeerPort[] ports;
+    }
+
     public struct BlockRange
     {
         public readonly Block[] blocks;
@@ -64,6 +73,8 @@ public class ListMessage : Message
         private ChainInfo[] _chains = null;
         public IEnumerable<ChainInfo> Chains => _chains;
 
+        public PeerInfo _peerInfo = null;
+
         public const int MaxPeers = 255;
         public const int MaxChains = 128;
         public const int MaxTransactions = 1024; // for mempool
@@ -169,6 +180,22 @@ internal static ListMessage FromReader(Address address, string host, BinaryReade
                 }
             }
 
+            if (kind.HasFlag(RequestKind.Info))
+            {
+                var version = reader.ReadVarString();
+                var caps = (PeerCaps)reader.ReadInt32();
+                var minimumFee = reader.ReadBigInteger();
+                var minimumPow = (int)reader.ReadVarInt();
+                var portCount = (int)reader.ReadVarInt();
+                var ports = new PeerPort[portCount];
+                for (int i=0; i<portCount; i++)
+                {
+                    var portName = reader.ReadVarString();
+                    var portNumber = (int)reader.ReadVarInt();
+                    ports[i] = new PeerPort(portName, portNumber);
+                }
+            }
+
             return result;
         }
 
@@ -233,6 +260,20 @@ protected override void OnSerialize(BinaryWriter writer)
                     }
                 }
             }
+
+            if (Kind.HasFlag(RequestKind.Info))
+            {
+                writer.WriteVarString(_peerInfo.version);
+                writer.Write((int)_peerInfo.caps);
+                writer.WriteBigInteger(_peerInfo.minimumFee);
+                writer.WriteVarInt(_peerInfo.minimumPow);
+                writer.WriteVarInt(_peerInfo.ports.Length);
+                foreach (var entry in _peerInfo.ports)
+                {
+                    writer.WriteVarString(entry.Name);
+                    writer.WriteVarInt(entry.Port);
+                }
+            }
         }
 
         public override IEnumerable<string> GetDescription()
@@ -312,5 +353,19 @@ public void AddBlockRange(Chain chain, BigInteger startHeight, uint count)
 
             AddBlockRange(chain.Name, blocks.ToArray(), transactions);
         }
+
+        public void SetInfo(string version, PeerCaps caps, BigInteger minimumFee, uint minimumPow, IEnumerable<PeerPort> ports)
+        {
+            var info = new PeerInfo()
+            {
+                version = version,
+                caps = caps,
+                minimumFee = minimumFee,
+                minimumPow = minimumPow,
+                ports = ports.ToArray()
+            };
+
+            this._peerInfo = info;
+        }
     }
 }

Phantasma.P2P/Messages/RequestMessage.cs

@@ -17,6 +17,7 @@ public enum RequestKind
         Mempool = 0x4,
         Blocks = 0x8,
         Transactions = 0x16,
+        Info = 0x32,
     }
 
     public struct RequestRange

Phantasma.P2P/Node.cs

@@ -78,7 +78,7 @@ public sealed partial class Node : Runnable
 
         public readonly string Version;
 
-        public readonly int Port;
+        public readonly int SyncPort;
         public readonly string Host;
         public readonly string PublicEndpoint;
         public readonly PeerCaps Capabilities;
@@ -113,11 +113,13 @@ public sealed partial class Node : Runnable
 
         private DateTime _lastRequestTime = DateTime.UtcNow;
 
+        public readonly PeerPort[] AvailablePorts;
+
         public bool IsFullySynced { get; private set; }
 
         public string ProxyURL = null;
 
-        public Node(string version, Nexus nexus, Mempool mempool, PhantasmaKeys keys, string publicHost, int port, PeerCaps caps, IEnumerable<string> seeds, Logger log)
+        public Node(string version, Nexus nexus, Mempool mempool, PhantasmaKeys keys, string publicHost, IEnumerable<PeerPort> availablePorts, PeerCaps caps, IEnumerable<string> seeds, Logger log)
         {
             if (mempool != null)
             {
@@ -129,11 +131,15 @@ public Node(string version, Nexus nexus, Mempool mempool, PhantasmaKeys keys, st
                 Throw.If(caps.HasFlag(PeerCaps.Mempool), "mempool included in caps but mempool instance is null");
             }
 
+            var syncPort = availablePorts.FirstOrDefault(x => x.Name.Equals("sync", StringComparison.OrdinalIgnoreCase)).Port;
+            Throw.If(syncPort <= 0, "missing sync port");
+
             this.Logger = Logger.Init(log);
 
             this.Version = version;
             this.Nexus = nexus;
-            this.Port = port;
+            this.SyncPort = syncPort;
+            this.AvailablePorts = availablePorts.ToArray();
             this.Keys = keys;
             this.Capabilities = caps;
 
@@ -157,7 +163,7 @@ public Node(string version, Nexus nexus, Mempool mempool, PhantasmaKeys keys, st
             Throw.If(publicHost.Contains(":"), "invalid host, protocol or port number should not be included");
             this.Host = publicHost;
 
-            this.PublicEndpoint = $"tcp:{publicHost}:{port}";
+            this.PublicEndpoint = $"tcp:{publicHost}:{syncPort}";
 
             if (this.Capabilities.HasFlag(PeerCaps.Sync))
             {
@@ -166,7 +172,7 @@ public Node(string version, Nexus nexus, Mempool mempool, PhantasmaKeys keys, st
                 // TODO this is a security issue, later change this to be configurable and default to localhost
                 var bindAddress = IPAddress.Any;
 
-                listener = new TcpListener(bindAddress, port);
+                listener = new TcpListener(bindAddress, syncPort);
 
                 if (seeds.Any())
                 {
@@ -220,7 +226,7 @@ public bool ParseEndpoint(string src, out PeerProtocol protocol, out IPAddress i
             }
             else
             {
-                port = this.Port;
+                port = this.SyncPort;
             }
 
             if (!IPAddress.TryParse(src, out ipAddress))
@@ -326,7 +332,7 @@ protected override void OnStart()
         {
             if (this.Capabilities.HasFlag(PeerCaps.Sync))
             {
-                Logger.Message($"Phantasma node listening on port {Port}, using address: {Address}");
+                Logger.Message($"Phantasma node listening on port {SyncPort}, using address: {Address}");
 
                 listener.Start();
             }
@@ -465,7 +471,7 @@ private void HandleConnection(Socket socket)
             var peer = new TCPPeer(socket);
 
             // this initial message is not only used to fetch chains but also to verify identity of peers
-            var requestKind = RequestKind.Chains | RequestKind.Peers;
+            var requestKind = RequestKind.Chains | RequestKind.Peers | RequestKind.Info;
             if (Capabilities.HasFlag(PeerCaps.Mempool))
             {
                 requestKind |= RequestKind.Mempool;
@@ -688,6 +694,11 @@ private Message HandleMessage(Peer peer, Message msg)
                             answer.SetPeers(this.Peers.Where(x => x != peer).Select(x => x.Endpoint.ToString()));
                         }
 
+                        if (request.Kind.HasFlag(RequestKind.Info))
+                        {
+                            answer.SetInfo(this.Version, this.Capabilities, this.MinimumFee, this.MinimumPoW, this.AvailablePorts);
+                        }
+
                         if (request.Kind.HasFlag(RequestKind.Chains))
                         {
                             var chainList = Nexus.GetChains(Nexus.RootStorage);

Phantasma.P2P/Peer.cs

@@ -3,6 +3,7 @@
 using Phantasma.Domain;
 using Phantasma.Numerics;
 using System;
+using System.Collections.Generic;
 
 namespace Phantasma.Network.P2P
 {
@@ -20,6 +21,18 @@ public enum PeerCaps
         REST = 0x40,
     }
 
+    public struct PeerPort
+    {
+        public readonly string Name;
+        public readonly int Port;
+
+        public PeerPort(string name, int port)
+        {
+            Name = name;
+            Port = port;
+        }
+    }
+
     public abstract class Peer
     {
         public Address Address { get; private set; }
@@ -33,6 +46,8 @@ public abstract class Peer
         public BigInteger MinimumFee { get; set; }
         public int MinimumPoW { get; set; }
 
+        public List<PeerPort> Ports { get; set; }
+
         public abstract void Send(Message msg);
         public abstract Message Receive();