Merge pull request #870 from fassadlr/merge1200

Merge release/1.2.0.0 to Master

Scripts/STRAXSidechainRegistrationScript.ps1

@@ -188,7 +188,8 @@ While ( ( Get-MaxHeight ) -eq $null )
 While ( ( Get-MaxHeight ) -gt ( Get-LocalIndexerHeight ) ) 
 {
     $a = Get-MaxHeight
-    $b = Get-LocalIndexerHeight 
+    $b = Get-LocalIndexerHeight
+    $c = $a - $b
     [int]$percentage = $b / $a * 100
     ""
     Write-Host (Get-TimeStamp) "$percentage% Synced" -ForegroundColor Cyan

src/FederationSetup/FederationSetup.csproj

@@ -3,7 +3,7 @@
   <PropertyGroup>
     <OutputType>Exe</OutputType>
     <TargetFramework>netcoreapp3.1</TargetFramework>
-    <Version>1.1.1.1</Version>
+    <Version>1.2.0.0</Version>
     <Authors>Stratis Group Ltd.</Authors>    
   </PropertyGroup>
 

src/FodyNlogAdapter/FodyNlogAdapter.csproj

@@ -3,7 +3,7 @@
   <PropertyGroup>
     <TargetFramework>netcoreapp3.1</TargetFramework>
     <AssemblyName>FodyNlogAdapter</AssemblyName>
-    <Version>1.1.1.1</Version>
+    <Version>1.2.0.0</Version>
     <GeneratePackageOnBuild>False</GeneratePackageOnBuild>
     <Authors>Stratis Group Ltd.</Authors>
     <PackageId>Stratis.Utils.FodyNlogAdapter</PackageId>

src/NBitcoin/BIP39/Mnemonic.cs

@@ -27,7 +27,7 @@ public Mnemonic(string mnemonic, Wordlist wordlist = null)
                 wordlist = Wordlist.AutoDetect(mnemonic) ?? Wordlist.English;
 
             string[] words = mnemonic.Split((char[])null, StringSplitOptions.RemoveEmptyEntries);
-            _Mnemonic = string.Join(wordlist.Space.ToString(), words);
+            this._Mnemonic = string.Join(wordlist.Space.ToString(), words);
 
             //if the sentence is not at least 12 characters or cleanly divisible by 3, it is bad!
             if (!CorrectWordCount(words.Length))
@@ -54,7 +54,7 @@ public Mnemonic(Wordlist wordList, byte[] entropy = null)
 
             int i = Array.IndexOf(entArray, entropy.Length * 8);
             if(i == -1)
-                throw new ArgumentException("The length for entropy should be : " + String.Join(",", entArray), "entropy");
+                throw new ArgumentException("The length for entropy should be : " + string.Join(",", entArray), "entropy");
 
             int cs = csArray[i];
             byte[] checksum = Hashes.SHA256(entropy);
@@ -200,10 +200,10 @@ public ExtKey DeriveExtKey(string passphrase = null)
             return new ExtKey(DeriveSeed(passphrase));
         }
 
-        private static Byte[] Concat(Byte[] source1, Byte[] source2)
+        private static byte[] Concat(byte[] source1, byte[] source2)
         {
             //Most efficient way to merge two arrays this according to http://stackoverflow.com/questions/415291/best-way-to-combine-two-or-more-byte-arrays-in-c-sharp
-            var buffer = new Byte[source1.Length + source2.Length];
+            var buffer = new byte[source1.Length + source2.Length];
             Buffer.BlockCopy(source1, 0, buffer, 0, source1.Length);
             Buffer.BlockCopy(source2, 0, buffer, source1.Length, source2.Length);
 

src/NBitcoin/ConsensusOptions.cs

@@ -13,7 +13,7 @@ public class ConsensusOptions
         /// </summary>
         public const int SerializeTransactionNoWitness = 0x40000000;
 
-        /// <summary>Maximum size for a block in bytes. </summary>
+        /// <summary>Maximum size for a block in bytes.</summary>
         public uint MaxBlockBaseSize { get; set; }
 
         /// <summary>The maximum allowed weight for a block, see BIP 141 (network rule)</summary>

src/NBitcoin/Money.cs

@@ -857,7 +857,7 @@ public string Format(string format, object arg, IFormatProvider formatProvider)
                 i++;
             }
             char unit = format[i];
-            var unitToUseInCalc = MoneyUnit.BTC;
+            MoneyUnit unitToUseInCalc = MoneyUnit.BTC;
             switch (unit)
             {
                 case 'B':

src/NBitcoin/NBitcoin.csproj

@@ -2,12 +2,12 @@
 
   <PropertyGroup>
     <Company>NStratis</Company>
-    <Copyright>Copyright © Stratis Platform SA 2020</Copyright>
+    <Copyright>Copyright © Stratis Platform SA 2022</Copyright>
     <Description>The C# Bitcoin Library based on NBitcoin</Description>
   </PropertyGroup>
 
   <PropertyGroup>
-    <Version>4.0.0.83</Version>
+    <Version>4.0.0.84</Version>
   </PropertyGroup>
 
   <PropertyGroup>

src/NBitcoin/TransactionBuilder.cs

@@ -1584,7 +1584,7 @@ public int EstimateSize(Transaction tx, bool virtualSize)
             int witSize = 0;
             if (tx.HasWitness)
                 witSize += 2;
-            foreach (var txin in tx.Inputs.AsIndexedInputs())
+            foreach (IndexedTxIn txin in tx.Inputs.AsIndexedInputs())
             {
                 ICoin coin = FindSignableCoin(txin) ?? FindCoin(txin.PrevOut);
                 if (coin == null)

src/Stratis.Bitcoin.Api.Tests/ApiSettingsTest.cs

@@ -231,7 +231,7 @@ public void GivenUseHttps_ThenUsesTheCorrectProtocol(bool useHttps, string expec
             var nodeSettings = new NodeSettings(KnownNetworks.TestNet, args: new[] { $"-usehttps={useHttps}", "-certificatefilepath=nonNullValue" });
 
             // Act.
-            var settings = FullNodeSetup(nodeSettings);
+            ApiSettings settings = FullNodeSetup(nodeSettings);
 
             // Assert.
             settings.UseHttps.Should().Be(useHttps);

src/Stratis.Bitcoin.Cli/Stratis.Bitcoin.Cli.csproj

@@ -3,7 +3,7 @@
   <PropertyGroup>
     <OutputType>Exe</OutputType>
     <TargetFramework>netcoreapp3.1</TargetFramework>
-    <Version>1.1.1.1</Version>
+    <Version>1.2.0.0</Version>
     <Authors>Stratis Group Ltd.</Authors>
     <Company>Stratis Group Ltd.</Company>
     <Product />

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

@@ -7,14 +7,14 @@
 using Microsoft.AspNetCore.Mvc;
 using Microsoft.Extensions.Logging;
 using NBitcoin;
-using NLog;
 using NLog.Config;
 using NLog.Targets;
 using NLog.Targets.Wrappers;
 using Stratis.Bitcoin.AsyncWork;
 using Stratis.Bitcoin.Base;
 using Stratis.Bitcoin.Builder.Feature;
 using Stratis.Bitcoin.Configuration;
+using Stratis.Bitcoin.Configuration.Logging;
 using Stratis.Bitcoin.Connection;
 using Stratis.Bitcoin.Consensus;
 using Stratis.Bitcoin.Controllers.Models;
@@ -27,7 +27,6 @@
 using Stratis.Bitcoin.Utilities;
 using Stratis.Bitcoin.Utilities.JsonErrors;
 using Stratis.Bitcoin.Utilities.ModelStateErrors;
-using ILogger = Microsoft.Extensions.Logging.ILogger;
 using LogLevel = NLog.LogLevel;
 using Target = NBitcoin.Target;
 
@@ -221,33 +220,34 @@ public IActionResult Status([FromQuery] bool publish)
         /// <param name="hash">The hash of the block to retrieve.</param>
         /// <param name="isJsonFormat">A flag that specifies whether to return the block header in the JSON format. Defaults to true. A value of false is currently not supported.</param>
         /// <returns>Json formatted <see cref="BlockHeaderModel"/>. <c>null</c> if block not found. Returns <see cref="Microsoft.AspNetCore.Mvc.IActionResult"/> formatted error if fails.</returns>
-        /// <exception cref="NotImplementedException">Thrown if isJsonFormat = false</exception>"
-        /// <exception cref="ArgumentException">Thrown if hash is empty.</exception>
-        /// <exception cref="ArgumentNullException">Thrown if logger is not provided.</exception>
+        /// <response code="200">Returns the blockheader if found.</response>
+        /// <response code="400">Null hash provided, BlockHeader does not exist or if isJsonFormat = false>/response>
         /// <remarks>Binary serialization is not supported with this method.</remarks>
         [Route("getblockheader")]
         [HttpGet]
+        [ProducesResponseType((int)HttpStatusCode.OK)]
+        [ProducesResponseType((int)HttpStatusCode.BadRequest)]
+        [ProducesResponseType((int)HttpStatusCode.NotFound)]
         public IActionResult GetBlockHeader([FromQuery] string hash, bool isJsonFormat = true)
         {
             try
             {
-                Guard.NotEmpty(hash, nameof(hash));
+                if (string.IsNullOrEmpty(hash))
+                    return ErrorHelpers.BuildErrorResponse(HttpStatusCode.BadRequest, "Error", "Null hash provided.");
 
                 this.logger.LogDebug("GetBlockHeader {0}", hash);
+
                 if (!isJsonFormat)
                 {
                     this.logger.LogError("Binary serialization is not supported.");
-                    throw new NotImplementedException();
+                    return ErrorHelpers.BuildErrorResponse(HttpStatusCode.BadRequest, "Error", "Binary serialization is not supported.");
                 }
 
-                BlockHeaderModel model = null;
                 BlockHeader blockHeader = this.chainIndexer?.GetHeader(uint256.Parse(hash))?.Header;
-                if (blockHeader != null)
-                {
-                    model = new BlockHeaderModel(blockHeader);
-                }
+                if (blockHeader == null)
+                    return this.NotFound($"Block header for '{hash}' not found");
 
-                return this.Json(model);
+                return this.Json(new BlockHeaderModel(blockHeader));
             }
             catch (Exception e)
             {
@@ -385,7 +385,7 @@ public IActionResult ValidateAddress([FromQuery] string address)
 
             if (result.IsValid)
             {
-                var scriptPubKey = BitcoinAddress.Create(address, this.network).ScriptPubKey;
+                NBitcoin.Script scriptPubKey = BitcoinAddress.Create(address, this.network).ScriptPubKey;
                 result.ScriptPubKey = scriptPubKey.ToHex();
                 result.IsWitness = scriptPubKey.IsWitness(this.network);
             }
@@ -453,7 +453,7 @@ public async Task<IActionResult> GetTxOutAsync([FromQuery] string trxid, uint vo
         /// <returns>The hex-encoded merkle proof.</returns>
         [Route("gettxoutproof")]
         [HttpGet]
-        public async Task<IActionResult> GetTxOutProofAsync([FromQuery] string[] txids, string blockhash = "")
+        public Task<IActionResult> GetTxOutProofAsync([FromQuery] string[] txids, string blockhash = "")
         {
             List<uint256> transactionIds = txids.Select(txString => uint256.Parse(txString)).ToList();
 
@@ -500,7 +500,7 @@ public async Task<IActionResult> GetTxOutProofAsync([FromQuery] string[] txids,
 
             var result = new MerkleBlock(block.Block, transactionIds.ToArray());
 
-            return this.Json(result);
+            return Task.FromResult<IActionResult>(this.Json(result));
         }
 
         /// <summary>
@@ -529,6 +529,8 @@ public IActionResult Shutdown([FromBody] bool corsProtection = true)
         /// Signals the node to rewind to the specified height.
         /// This will be done via writing a flag to the .conf file so that on startup it be executed.
         /// </summary>
+        /// <param name="height">The rewind height.</param>
+        /// <returns>A json text result indicating success or an <see cref="ErrorResult"/> indicating failure.</returns>
         [Route("rewind")]
         [HttpPut]
         [ProducesResponseType((int)HttpStatusCode.OK)]
@@ -697,7 +699,7 @@ public IActionResult GetAsyncLoops()
         /// <summary>
         /// Schedules data folder storing chain state in the <see cref="DataFolder"/> for deletion on the next graceful shutdown.
         /// </summary>
-        /// <returns></returns>
+        /// <returns>Returns an <see cref="OkResult"/>.</returns>
         [HttpDelete]
         [Route("datafolder/chain")]
         public IActionResult DeleteChain()
@@ -717,7 +719,7 @@ public IActionResult DeleteChain()
         /// <exception cref="ArgumentNullException">Thrown if fullnode is not provided.</exception>
         internal ChainedHeader GetTransactionBlock(uint256 trxid, ChainIndexer chain)
         {
-            Guard.NotNull(fullNode, nameof(fullNode));
+            Guard.NotNull(this.fullNode, nameof(this.fullNode));
 
             ChainedHeader block = null;
             uint256 blockid = this.blockStore?.GetBlockIdByTransactionId(trxid);

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

@@ -9,7 +9,6 @@
 using Microsoft.Extensions.Logging;
 using Microsoft.Extensions.Options;
 using Microsoft.OpenApi.Models;
-using Newtonsoft.Json.Converters;
 using Swashbuckle.AspNetCore.SwaggerGen;
 using Swashbuckle.AspNetCore.SwaggerUI;
 
@@ -74,7 +73,9 @@ public void ConfigureServices(IServiceCollection services)
                 {
                     options.Filters.Add(typeof(LoggingActionFilter));
 
+#pragma warning disable ASP0000 // Do not call 'IServiceCollection.BuildServiceProvider' in 'ConfigureServices'
                     ServiceProvider serviceProvider = services.BuildServiceProvider();
+#pragma warning restore ASP0000 // Do not call 'IServiceCollection.BuildServiceProvider' in 'ConfigureServices'
                     var apiSettings = (ApiSettings)serviceProvider.GetRequiredService(typeof(ApiSettings));
                     if (apiSettings.KeepaliveTimer != null)
                     {

src/Stratis.Bitcoin.Features.Api/Stratis.Bitcoin.Features.Api.csproj

@@ -6,7 +6,7 @@
     <AssemblyName>Stratis.Bitcoin.Features.Api</AssemblyName>
     <OutputType>Library</OutputType>
     <PackageId>Stratis.Features.Api</PackageId>
-    <Version>1.1.1.1</Version>
+    <Version>1.2.0.0</Version>
     <GeneratePackageOnBuild>False</GeneratePackageOnBuild>
     <ApplicationIcon />
     <OutputTypeEx>library</OutputTypeEx>

src/Stratis.Bitcoin.Features.BlockStore.Tests/AddressIndexerOutpointsRepositoryTests.cs

@@ -4,7 +4,6 @@
 using System.Runtime.InteropServices;
 using LiteDB;
 using NBitcoin;
-using Stratis.Bitcoin.Configuration.Logging;
 using Stratis.Bitcoin.Features.BlockStore.AddressIndexing;
 using Xunit;
 
@@ -23,7 +22,7 @@ public AddressIndexerOutpointsRepositoryTests()
             FileMode fileMode = RuntimeInformation.IsOSPlatform(OSPlatform.OSX) ? FileMode.Exclusive : FileMode.Shared;
             var db = new LiteDatabase(new ConnectionString() { Filename = this.RandomString(20) + ".litedb", Mode = fileMode });
 
-            this.repository = new AddressIndexerOutpointsRepository(db, new ExtendedLoggerFactory(), this.maxItems);
+            this.repository = new AddressIndexerOutpointsRepository(db, this.maxItems);
         }
 
         [Fact]

src/Stratis.Bitcoin.Features.BlockStore.Tests/AddressIndexerTests.cs

@@ -7,7 +7,6 @@
 using NBitcoin;
 using Stratis.Bitcoin.AsyncWork;
 using Stratis.Bitcoin.Configuration;
-using Stratis.Bitcoin.Configuration.Logging;
 using Stratis.Bitcoin.Consensus;
 using Stratis.Bitcoin.Controllers.Models;
 using Stratis.Bitcoin.Features.BlockStore.AddressIndexing;
@@ -52,7 +51,7 @@ public AddressIndexerTests()
 
             var utxoIndexerMock = new Mock<IUtxoIndexer>();
 
-            this.addressIndexer = new AddressIndexer(storeSettings, dataFolder, new ExtendedLoggerFactory(), this.network, stats.Object,
+            this.addressIndexer = new AddressIndexer(storeSettings, dataFolder, this.network, stats.Object,
                 this.consensusManagerMock.Object, this.asyncProviderMock.Object, indexer, new DateTimeProvider(), utxoIndexerMock.Object);
 
             this.genesisHeader = new ChainedHeader(this.network.GetGenesis().Header, this.network.GetGenesis().Header.GetHash(), 0);
@@ -182,7 +181,7 @@ public void OutPointCacheCanRetrieveExisting()
             FileMode fileMode = RuntimeInformation.IsOSPlatform(OSPlatform.OSX) ? FileMode.Exclusive : FileMode.Shared;
 
             var database = new LiteDatabase(new ConnectionString() { Filename = dbPath, Mode = fileMode });
-            var cache = new AddressIndexerOutpointsRepository(database, new ExtendedLoggerFactory());
+            var cache = new AddressIndexerOutpointsRepository(database);
 
             var outPoint = new OutPoint(uint256.Parse("0000af9ab2c8660481328d0444cf167dfd31f24ca2dbba8e5e963a2434cffa93"), 0);
 
@@ -205,7 +204,7 @@ public void OutPointCacheCannotRetrieveNonexistent()
             FileMode fileMode = RuntimeInformation.IsOSPlatform(OSPlatform.OSX) ? FileMode.Exclusive : FileMode.Shared;
 
             var database = new LiteDatabase(new ConnectionString() { Filename = dbPath, Mode = fileMode });
-            var cache = new AddressIndexerOutpointsRepository(database, new ExtendedLoggerFactory());
+            var cache = new AddressIndexerOutpointsRepository(database);
 
             Assert.False(cache.TryGetOutPointData(new OutPoint(uint256.Parse("0000af9ab2c8660481328d0444cf167dfd31f24ca2dbba8e5e963a2434cffa93"), 1), out OutPointData retrieved));
             Assert.Null(retrieved);
@@ -220,7 +219,7 @@ public void OutPointCacheEvicts()
             FileMode fileMode = RuntimeInformation.IsOSPlatform(OSPlatform.OSX) ? FileMode.Exclusive : FileMode.Shared;
 
             var database = new LiteDatabase(new ConnectionString() { Filename = dbPath, Mode = fileMode });
-            var cache = new AddressIndexerOutpointsRepository(database, new ExtendedLoggerFactory(), 2);
+            var cache = new AddressIndexerOutpointsRepository(database, 2);
 
             Assert.Equal(0, cache.Count);
             Assert.Equal(0, database.GetCollection<OutPointData>(CollectionName).Count());
@@ -271,7 +270,7 @@ public void AddressCacheCanRetrieveExisting()
             FileMode fileMode = RuntimeInformation.IsOSPlatform(OSPlatform.OSX) ? FileMode.Exclusive : FileMode.Shared;
 
             var database = new LiteDatabase(new ConnectionString() { Filename = dbPath, Mode = fileMode });
-            var cache = new AddressIndexRepository(database, new ExtendedLoggerFactory());
+            var cache = new AddressIndexRepository(database);
 
             string address = "xyz";
             var balanceChanges = new List<AddressBalanceChange>();
@@ -300,7 +299,7 @@ public void AddressCacheRetrievesBlankRecordForNonexistent()
             FileMode fileMode = RuntimeInformation.IsOSPlatform(OSPlatform.OSX) ? FileMode.Exclusive : FileMode.Shared;
 
             var database = new LiteDatabase(new ConnectionString() { Filename = dbPath, Mode = fileMode });
-            var cache = new AddressIndexRepository(database, new ExtendedLoggerFactory());
+            var cache = new AddressIndexRepository(database);
 
             AddressIndexerData retrieved = cache.GetOrCreateAddress("xyz");
 
@@ -319,7 +318,7 @@ public void AddressCacheEvicts()
             FileMode fileMode = RuntimeInformation.IsOSPlatform(OSPlatform.OSX) ? FileMode.Exclusive : FileMode.Shared;
 
             var database = new LiteDatabase(new ConnectionString() { Filename = dbPath, Mode = fileMode });
-            var cache = new AddressIndexRepository(database, new ExtendedLoggerFactory(), 4);
+            var cache = new AddressIndexRepository(database, 4);
 
             // Recall, each index entry counts as 1 and each balance change associated with it is an additional 1.
             Assert.Equal(0, database.GetCollection<AddressIndexerData>(CollectionName).Count());

src/Stratis.Bitcoin.Features.BlockStore.Tests/BlockStoreControllerTests.cs

@@ -68,9 +68,9 @@ public void Get_Block_When_Hash_Is_Not_Found_Should_Return_OkResult_WithMessage(
 
             IActionResult response = controller.GetBlock(new SearchByHashRequest() { Hash = new uint256(1).ToString(), OutputJson = true });
 
-            response.Should().BeOfType<OkObjectResult>();
-            var result = (OkObjectResult)response;
-            result.StatusCode.Should().Be((int)HttpStatusCode.OK);
+            response.Should().BeOfType<NotFoundObjectResult>();
+            var result = (NotFoundObjectResult)response;
+            result.StatusCode.Should().Be((int)HttpStatusCode.NotFound);
             result.Value.Should().Be("Block not found");
         }
 

src/Stratis.Bitcoin.Features.BlockStore.Tests/BlockStoreTests.cs

@@ -333,6 +333,7 @@ public async Task ReorgedBlocksAreNotSavedAsync()
         /// <summary>
         /// Tests reorgs inside the batch and inside the database at the same time.
         /// </summary>
+        /// <returns>The asynchronous task.</returns>
         [Fact]
         [Trait("Unstable", "True")]
         public async Task ReorgedBlocksAreDeletedFromRepositoryIfReorgDetectedAsync()