[API] Add extra mining stats information for the dashboard (#732)

* Fix poll repo progress string

* Add mining stats via POAMiner

* Review

Author: fassadlr

src/Stratis.Bitcoin.Features.Api/NodeController.cs

@@ -152,6 +152,7 @@ public IActionResult Status([FromQuery] bool publish)
                 ProcessId = Process.GetCurrentProcess().Id,
                 Network = this.fullNode.Network.Name,
                 ConsensusHeight = this.chainState.ConsensusTip?.Height,
+                HeaderHeight = this.consensusManager.HeaderTip,
                 DataDirectoryPath = this.nodeSettings.DataDir,
                 Testnet = this.network.IsTest(),
                 RelayFee = this.nodeSettings.MinRelayTxFeeRate?.FeePerK?.ToUnit(MoneyUnit.BTC) ?? 0,

src/Stratis.Bitcoin.Features.PoA/Models/FederationMemberModel.cs

@@ -46,5 +46,8 @@ public sealed class FederationMemberDetailedModel : FederationMemberModel
 
         [JsonProperty("rewardEstimatePerBlock")]
         public double RewardEstimatePerBlock { get; set; }
+
+        [JsonProperty("miningStats")]
+        public MiningStatisticsModel MiningStatistics { get; set; }
     }
 }

src/Stratis.Bitcoin.Features.PoA/PoAMiner.cs

@@ -6,6 +6,7 @@
 using System.Threading.Tasks;
 using Microsoft.Extensions.Logging;
 using NBitcoin;
+using Newtonsoft.Json;
 using Stratis.Bitcoin.AsyncWork;
 using Stratis.Bitcoin.Configuration;
 using Stratis.Bitcoin.Configuration.Logging;
@@ -37,6 +38,12 @@ public interface IPoAMiner : IDisposable
     {
         /// <summary>Starts mining loop.</summary>
         void InitializeMining();
+
+        /// <summary>
+        /// Returns mining statistics in the last amount of blocks equal to the federation size.
+        /// </summary>
+        /// <returns>Returns <c>true</c> if the miner produced a block in the last round and block producer hits.</returns>
+        MiningStatisticsModel MiningStatistics { get; }
     }
 
     /// <inheritdoc cref="IPoAMiner"/>
@@ -75,6 +82,8 @@ public class PoAMiner : IPoAMiner
 
         private readonly NodeSettings nodeSettings;
 
+        private MiningStatisticsModel miningStatistics;
+
         private readonly IWalletManager walletManager;
 
         protected readonly VotingManager votingManager;
@@ -422,7 +431,6 @@ private void AddComponentStats(StringBuilder log)
                 log.AppendLine();
                 return;
             }
-
             ChainedHeader tip = this.consensusManager.Tip;
             ChainedHeader currentHeader = tip;
 
@@ -441,14 +449,21 @@ private void AddComponentStats(StringBuilder log)
             if (timeHeader < currentHeader.Header.Time)
                 timeHeader += this.network.ConsensusOptions.TargetSpacingSeconds;
 
+            var statistics = new MiningStatisticsModel();
+
             // Iterate mining slots.
             for (int i = 0; i < maxDepth; i++)
             {
                 int headerSlot = (int)(timeHeader / this.network.ConsensusOptions.TargetSpacingSeconds) % modifiedFederation.Count;
 
                 PubKey pubKey = modifiedFederation[headerSlot].PubKey;
 
-                string pubKeyRepresentation = (pubKey == this.federationManager.CurrentFederationKey?.PubKey) ? "█████" : pubKey.ToString().Substring(0, pubKeyTakeCharacters);
+                string pubKeyRepresentation = pubKey.ToString().Substring(0, pubKeyTakeCharacters);
+                if (pubKey == this.federationManager.CurrentFederationKey?.PubKey)
+                {
+                    pubKeyRepresentation = "█████";
+                    statistics.ProducedBlockInLastRound = true;
+                }
 
                 // Mined in this slot?
                 if (timeHeader == currentHeader.Header.Time)
@@ -471,13 +486,22 @@ private void AddComponentStats(StringBuilder log)
                     log.AppendLine();
             }
 
+            statistics.FederationSize = maxDepth;
+            statistics.MinerHits = hitCount;
+
             log.Append("...");
             log.AppendLine();
             log.AppendLine($"Miner hits".PadRight(LoggingConfiguration.ColumnLength) + $": {hitCount} of {maxDepth}({(((float)hitCount / (float)maxDepth)).ToString("P2")})");
             log.AppendLine($"Miner idle time".PadRight(LoggingConfiguration.ColumnLength) + $": { TimeSpan.FromSeconds(this.network.ConsensusOptions.TargetSpacingSeconds * (maxDepth - hitCount)).ToString(@"hh\:mm\:ss")}");
             log.AppendLine();
         }
 
+        /// <inheritdoc/>
+        public MiningStatisticsModel MiningStatistics
+        {
+            get { return this.miningStatistics; }
+        }
+
         /// <inheritdoc/>
         public virtual void Dispose()
         {
@@ -487,4 +511,16 @@ public virtual void Dispose()
             this.cancellation.Dispose();
         }
     }
+
+    public sealed class MiningStatisticsModel
+    {
+        [JsonProperty(PropertyName = "federationSize")]
+        public int FederationSize { get; set; }
+
+        [JsonProperty(PropertyName = "minerHits")]
+        public int MinerHits { get; set; }
+
+        [JsonProperty(PropertyName = "producedBlockInLastRound")]
+        public bool ProducedBlockInLastRound { get; set; }
+    }
 }

src/Stratis.Bitcoin.Features.PoA/Voting/FederationController.cs

@@ -21,6 +21,7 @@ public sealed class FederationController : Controller
         private readonly IFederationHistory federationHistory;
         private readonly ILogger logger;
         private readonly Network network;
+        private readonly IPoAMiner poaMiner;
         private readonly ReconstructFederationService reconstructFederationService;
         private readonly VotingManager votingManager;
 
@@ -31,13 +32,15 @@ public FederationController(
             Network network,
             IIdleFederationMembersKicker idleFederationMembersKicker,
             IFederationHistory federationHistory,
+            IPoAMiner poAMiner,
             ReconstructFederationService reconstructFederationService)
         {
             this.chainIndexer = chainIndexer;
             this.federationManager = federationManager;
             this.idleFederationMembersKicker = idleFederationMembersKicker;
             this.federationHistory = federationHistory;
             this.network = network;
+            this.poaMiner = poAMiner;
             this.reconstructFederationService = reconstructFederationService;
             this.votingManager = votingManager;
 
@@ -129,6 +132,8 @@ public IActionResult GetCurrentMemberInfo()
 
                 federationMemberModel.RewardEstimatePerBlock = 9d / this.federationManager.GetFederationMembers().Count;
 
+                federationMemberModel.MiningStatistics = this.poaMiner.MiningStatistics;
+
                 return Json(federationMemberModel);
             }
             catch (Exception e)

src/Stratis.Bitcoin.Features.PoA/Voting/VotingManager.cs

@@ -832,8 +832,10 @@ internal bool Synchronize(ChainedHeader newTip)
                             if (header.Height % 10000 == 0)
                             {
                                 var progress = (int)((decimal)header.Height / this.chainIndexer.Tip.Height * 100);
-                                this.logger.Info($"Synchronizing voting data at height {header.Height} / {this.chainIndexer.Tip.Height} ({progress}%).");
-                                this.signals.Publish(new FullNodeEvent() { Message = $"Synchronizing voting data at height {header.Height} / {this.chainIndexer.Tip.Height} ({progress})%.", State = FullNodeState.Initializing.ToString() });
+                                var progressString = $"Synchronizing voting data at height {header.Height} / {this.chainIndexer.Tip.Height} ({progress} %).";
+
+                                this.logger.Info(progressString);
+                                this.signals.Publish(new FullNodeEvent() { Message = progressString, State = FullNodeState.Initializing.ToString() });
                             }
                         }
 

src/Stratis.Bitcoin/Controllers/Models/StatusModel.cs

@@ -38,9 +38,12 @@ public StatusModel()
         /// <summary>System identifier of the node's process.</summary>
         public int ProcessId { get; set; }
 
-        /// <summary>The height of the consensus.</summary>
+        /// <summary>The height of consensus.</summary>
         public int? ConsensusHeight { get; set; }
 
+        /// <summary>The height of the header store.</summary>
+        public int? HeaderHeight { get; set; }
+
         /// <summary>Height of the most recent block in persistent storage.</summary>
         /// <seealso cref="Stratis.Bitcoin.Features.BlockRepository.HighestPersistedBlock.Height"/>
         public int BlockStoreHeight { get; set; }