- async event bus

- code style fixes

Author: MithrilMan

.editorconfig

@@ -101,8 +101,8 @@ csharp_style_pattern_local_over_anonymous_function                = true : sugge
 csharp_style_pattern_matching_over_as_with_null_check             = true : error
 csharp_style_pattern_matching_over_is_with_cast_check             = true : error
 csharp_style_throw_expression                                     = true : silent
-csharp_style_var_elsewhere                                        = false : error
-csharp_style_var_for_built_in_types                               = false : error
+csharp_style_var_elsewhere                                        = false : suggestion
+csharp_style_var_for_built_in_types                               = false : suggestion
 csharp_style_var_when_type_is_apparent                            = true : suggestion
 
 
@@ -158,7 +158,7 @@ dotnet_diagnostic.CA1040.severity                                 = suggestion
 dotnet_diagnostic.CA1801.severity                                 = suggestion
 
 # Default severity for all analyzer diagnostics
-dotnet_analyzer_diagnostic.severity                               = silent
+#dotnet_analyzer_diagnostic.severity                               = silent
 
 # IDE1006: Naming Styles
 dotnet_diagnostic.IDE1006.severity                                = error
@@ -168,3 +168,6 @@ dotnet_diagnostic.CS1591.severity                                 = silent
 
 # CS1587: XML comment is not placed on a valid language element
 dotnet_diagnostic.CS1587.severity                                 = silent
+
+# IDE0090: Use 'new(...)'
+csharp_style_implicit_object_creation_when_type_is_apparent       = true: warning

benchmarks/MithrilShards.P2P.Benchmark/Benchmarks/DataTypes/MithrilShards/Uint256Candidates.cs

@@ -6,7 +6,7 @@ namespace MithrilShards.P2P.Benchmark.Benchmarks.DataTypes.MithrilShards
    public class UnsafeUInt256
    {
       private const int EXPECTED_SIZE = 32;
-      private static readonly NBitcoin.DataEncoders.HexEncoder _encoder = new NBitcoin.DataEncoders.HexEncoder();
+      private static readonly NBitcoin.DataEncoders.HexEncoder _encoder = new();
 
       private readonly byte[] _bytes;
 
@@ -36,7 +36,7 @@ public override string ToString()
    public class UInt256As4Long
    {
       private const int EXPECTED_SIZE = 32;
-      private static readonly NBitcoin.DataEncoders.HexEncoder _encoder = new NBitcoin.DataEncoders.HexEncoder();
+      private static readonly NBitcoin.DataEncoders.HexEncoder _encoder = new();
 
       private readonly long[] _data;
 
@@ -67,7 +67,7 @@ public override string ToString()
    public class UInt256As4Jhon
    {
       private const int EXPECTED_SIZE = 32;
-      private static readonly NBitcoin.DataEncoders.HexEncoder _encoder = new NBitcoin.DataEncoders.HexEncoder();
+      private static readonly NBitcoin.DataEncoders.HexEncoder _encoder = new();
 
       private readonly ulong _part1;
       private readonly ulong _part2;
@@ -97,7 +97,7 @@ public override string ToString()
    public class UnsafeUInt256As4Long
    {
       private const int EXPECTED_SIZE = 32;
-      private static readonly NBitcoin.DataEncoders.HexEncoder _encoder = new NBitcoin.DataEncoders.HexEncoder();
+      private static readonly NBitcoin.DataEncoders.HexEncoder _encoder = new();
 
       private readonly ulong _data1;
       private readonly ulong _data2;

benchmarks/MithrilShards.P2P.Benchmark/Benchmarks/DataTypes/Neo/Helper.cs

@@ -14,7 +14,7 @@ namespace MithrilShards.P2P.Benchmark.Benchmarks.DataTypes.Neo
 {
    public static class Helper
    {
-      private static readonly DateTime _unixEpoch = new DateTime(1970, 1, 1, 0, 0, 0, DateTimeKind.Utc);
+      private static readonly DateTime _unixEpoch = new(1970, 1, 1, 0, 0, 0, DateTimeKind.Utc);
 
       internal static byte[] ToArray(this SecureString s)
       {

benchmarks/MithrilShards.P2P.Benchmark/Benchmarks/DataTypes/Neo/NEO_UInt256.cs

@@ -12,7 +12,7 @@ public class NEO_UInt256 : UIntBase, IComparable<NEO_UInt256>, IEquatable<NEO_UI
    {
 
       public const int LENGTH = 32;
-      public static readonly NEO_UInt256 Zero = new NEO_UInt256();
+      public static readonly NEO_UInt256 Zero = new();
 
       private ulong _value1;
       private ulong _value2;
@@ -196,7 +196,7 @@ public static bool TryParse(string s, out NEO_UInt256 result)
 
 
 
-      private static readonly NBitcoin.DataEncoders.HexEncoder _encoder = new NBitcoin.DataEncoders.HexEncoder();
+      private static readonly NBitcoin.DataEncoders.HexEncoder _encoder = new();
       public override string ToString()
       {
          ulong[] arr = new ulong[] { _value1, _value2, _value3, _value4 };

benchmarks/MithrilShards.P2P.Benchmark/Benchmarks/DataTypes/Neo/UInt160.cs

@@ -10,7 +10,7 @@ namespace MithrilShards.P2P.Benchmark.Benchmarks.DataTypes.Neo
    public class UInt160 : UIntBase, IComparable<UInt160>, IEquatable<UInt160>
    {
       public const int LENGTH = 20;
-      public static readonly UInt160 Zero = new UInt160();
+      public static readonly UInt160 Zero = new();
 
       private ulong _value1;
       private ulong _value2;

benchmarks/MithrilShards.P2P.Benchmark/Benchmarks/Spot/CompareUInt256.cs

@@ -50,24 +50,20 @@ public bool AsBytes()
 
       public static ReadOnlySpan<byte> DoubleSha512AsBytes(ReadOnlySpan<byte> data)
       {
-         using (var sha = new SHA512Managed())
-         {
-            Span<byte> result = new byte[64];
-            sha.TryComputeHash(data, result, out _);
-            sha.TryComputeHash(result, result, out _);
-            return result.Slice(0, 32);
-         }
+         using var sha = new SHA512Managed();
+         Span<byte> result = new byte[64];
+         sha.TryComputeHash(data, result, out _);
+         sha.TryComputeHash(result, result, out _);
+         return result.Slice(0, 32);
       }
 
       public static Core.DataTypes.UInt256 DoubleSha512AsUInt256(ReadOnlySpan<byte> data)
       {
-         using (var sha = new SHA512Managed())
-         {
-            Span<byte> result = stackalloc byte[64];
-            sha.TryComputeHash(data, result, out _);
-            sha.TryComputeHash(result, result, out _);
-            return new Core.DataTypes.UInt256(result.Slice(0, 32));
-         }
+         using var sha = new SHA512Managed();
+         Span<byte> result = stackalloc byte[64];
+         sha.TryComputeHash(data, result, out _);
+         sha.TryComputeHash(result, result, out _);
+         return new Core.DataTypes.UInt256(result.Slice(0, 32));
       }
    }
 }

benchmarks/MithrilShards.P2P.Benchmark/Benchmarks/Spot/ComputeBlockHash.cs

@@ -16,7 +16,7 @@ public class ComputeBlockHash
       [Params(100, 1_000, 2_000)]
       public int N;
 
-      BlockHeaderHashCalculator _hashCalculator = new BlockHeaderHashCalculator(new BlockHeaderSerializer(new UInt256Serializer()));
+      BlockHeaderHashCalculator _hashCalculator = new(new BlockHeaderSerializer(new UInt256Serializer()));
 
       BlockHeader[] _headers;
 

benchmarks/MithrilShards.P2P.Benchmark/Benchmarks/Spot/MethodInfo_vs_Delegate.cs

@@ -39,8 +39,8 @@ public ValueTask<bool> ProcessMessageAsync(Message2 message, CancellationToken c
       private MethodInfo _method;
       private Delegate _computedDelegate;
       private Func<object, object[], object> _lambdaWrapper;
-      private readonly Message1 _messageInstance = new Message1();
-      private readonly Message2 _messageInstance2 = new Message2();
+      private readonly Message1 _messageInstance = new();
+      private readonly Message2 _messageInstance2 = new();
 
 
 

benchmarks/MithrilShards.P2P.Benchmark/Benchmarks/Target/Target_Study.cs

@@ -31,7 +31,7 @@ public class Target_Study
       uint _blockTime = 1262152739;
       uint _bits = 0x1d00ffff;
 
-      ProofOfWorkCalculator _powCalculator = new ProofOfWorkCalculator(
+      ProofOfWorkCalculator _powCalculator = new(
          new NullLogger<ProofOfWorkCalculator>(),
          new BitcoinMainDefinition(new BlockHeaderHashCalculator(new BlockHeaderSerializer(new UInt256Serializer()))).ConfigureConsensus(),
          null

benchmarks/MithrilShards.P2P.Benchmark/GlobalSuppressions.cs

@@ -3,16 +3,23 @@
 // Project-level suppressions either have no target or are given
 // a specific target and scoped to a namespace, type, member, etc.
 
-[assembly: System.Diagnostics.CodeAnalysis.SuppressMessage("Naming", "CA1707:Identifiers should not contain underscores", Justification = "<Pending>")]
-[assembly: System.Diagnostics.CodeAnalysis.SuppressMessage("Style", "IDE0008:Use explicit type", Justification = "<Pending>")]
-[assembly: System.Diagnostics.CodeAnalysis.SuppressMessage("Style", "IDE0011:Add braces", Justification = "<Pending>")]
-[assembly: System.Diagnostics.CodeAnalysis.SuppressMessage("Style", "IDE0009:Member access should be qualified.", Justification = "<Pending>")]
-[assembly: System.Diagnostics.CodeAnalysis.SuppressMessage("Design", "CA1062:Validate arguments of public methods", Justification = "<Pending>")]
-[assembly: System.Diagnostics.CodeAnalysis.SuppressMessage("Globalization", "CA1305:Specify IFormatProvider", Justification = "<Pending>")]
-[assembly: System.Diagnostics.CodeAnalysis.SuppressMessage("Performance", "CA1822:Mark members as static", Justification = "<Pending>")]
-[assembly: System.Diagnostics.CodeAnalysis.SuppressMessage("Usage", "CA2208:Instantiate argument exceptions correctly", Justification = "<Pending>")]
-[assembly: System.Diagnostics.CodeAnalysis.SuppressMessage("Code Quality", "IDE0051:Remove unused private members", Justification = "<Pending>")]
-[assembly: System.Diagnostics.CodeAnalysis.SuppressMessage("Performance", "CA1823: Avoid unused private fields")]
-[assembly: System.Diagnostics.CodeAnalysis.SuppressMessage("Style", "IDE0044:Add readonly modifier", Justification = "<Pending>")]
-[assembly: System.Diagnostics.CodeAnalysis.SuppressMessage("Style", "CS8632:The annotation for nullable reference types should only be used in code within a nullable")]
-[assembly: System.Diagnostics.CodeAnalysis.SuppressMessage("Compiler Warning", "CS1573")]
+using System.Diagnostics.CodeAnalysis;
+
+[assembly: SuppressMessage("Naming", "CA1707:Identifiers should not contain underscores", Justification = "<Pending>")]
+[assembly: SuppressMessage("Style", "IDE0008:Use explicit type", Justification = "<Pending>")]
+[assembly: SuppressMessage("Style", "IDE0011:Add braces", Justification = "<Pending>")]
+[assembly: SuppressMessage("Style", "IDE0009:Member access should be qualified.", Justification = "<Pending>")]
+[assembly: SuppressMessage("Design", "CA1062:Validate arguments of public methods", Justification = "<Pending>")]
+[assembly: SuppressMessage("Globalization", "CA1305:Specify IFormatProvider", Justification = "<Pending>")]
+[assembly: SuppressMessage("Performance", "CA1822:Mark members as static", Justification = "<Pending>")]
+[assembly: SuppressMessage("Usage", "CA2208:Instantiate argument exceptions correctly", Justification = "<Pending>")]
+[assembly: SuppressMessage("Code Quality", "IDE0051:Remove unused private members", Justification = "<Pending>")]
+[assembly: SuppressMessage("Performance", "CA1823: Avoid unused private fields")]
+[assembly: SuppressMessage("Style", "IDE0044:Add readonly modifier", Justification = "<Pending>")]
+[assembly: SuppressMessage("Style", "CS8632:The annotation for nullable reference types should only be used in code within a nullable")]
+[assembly: SuppressMessage("Compiler Warning", "CS1573")]
+[assembly: SuppressMessage("Style", "IDE0041:Use 'is null' check", Justification = "<Pending>")]
+[assembly: SuppressMessage("Style", "IDE0032:Use auto property", Justification = "<Pending>")]
+[assembly: SuppressMessage("Style", "IDE0090:Use 'new(...)'", Justification = "<Pending>")]
+[assembly: SuppressMessage("Style", "IDE0056:Use index operator", Justification = "<Pending>")]
+[assembly: SuppressMessage("Style", "IDE0047:Remove unnecessary parentheses", Justification = "<Pending>")]

docs/mithril-shards/default-forge.md

@@ -17,4 +17,4 @@ After all shards are initialized, they are started by invoking their `StartAsync
 
 From this moment, the forge is running.
 
-When the application lifetime runs out (in the default scenario by pressing CTRL+C when running in console) `StopAsync` method is called and it calls `StopAsync` on all running shards allowing them to close properly.
+When the application lifetime ends (in the default scenario by pressing CTRL+C when running in console) `StopAsync` method is called, which calls `StopAsync` on all running shards allowing them to close properly.

docs/mithril-shards/event-bus.md

@@ -0,0 +1,12 @@
+---
+title: Event Bus
+description: Mithril Shards implementation, Event Bus
+
+---
+
+--8<-- "refs.txt"
+
+Event Bus is a simple implementation of the [publish/subscribe pattern](https://en.wikipedia.org/wiki/Publish%E2%80%93subscribe_pattern){:target="_blank"} which is a messaging pattern that allows two or more actors to publish messages and handle these messages without having a direct relationship between them.
+
+Publishers don't know if the message they are publishing is handled and by whom, while subscribers do not know who was the publisher of a specific event: this means that components among Mithril Shards can be [loosely coupled](https://en.wikipedia.org/wiki/Loose_coupling){:target="_blank"} 
+

docs/mithril-shards/forge-builder.md

@@ -7,12 +7,11 @@ description: Mithril Shards implementation, ForgeBuilder class
 
 ForgeBuilder class represents the entry point of a Mithril Shards application, it allows to add a shard by calling the generic `AddShard` method, with different overloads that accept an optional strongly typed shard setting file with an optional setting file validator.
 
-By using `ConfigureLogging` it's possible to configure logging, it's basically a wrapper on  the inner hostbiulder ConfigureLogging method, you could use it to have a finer control over logging configuration and available providers, but the easier way to log is by using the available [SerilogShard] that uses Serilog to configure the logging and relies on a configurable setting file where you can specify which sink to use.
+By using `ConfigureLogging` it's possible to configure logging, it's basically a wrapper on  the inner [HostBuilder ConfigureLogging](https://docs.microsoft.com/en-us/dotnet/api/microsoft.aspnetcore.hosting.webhostbuilder.configurelogging?view=aspnetcore-1.1&viewFallbackFrom=aspnetcore-5.0){:target="_blank"} method, you could use it to have a finer control over logging configuration and available providers, but the easier way to log is by using the available [SerilogShard] that uses Serilog to configure the logging and relies on a configurable setting file where you can specify which sink to use.
 You can find more details on its specific documentation page and an example of its usage in the [example project]
 
 After declaring an instance we have to specify which implementation of Forge we want to use.
 Actually the only available implementation is [DefaultForge] class.
 
 
 
-

mkdocs.yml

@@ -107,6 +107,7 @@ nav:
     - mithril-shards/shards.md
     - mithril-shards/forge-builder.md
     - mithril-shards/default-forge.md
+    - mithril-shards/event-bus.md
   - Shards:
     - BedrockNetwork:
       -  shards/bedrock-network/index.md

src/MithrilShards.Chain.Bitcoin.Dev/Controllers/BlockFetcherManagerController.cs

@@ -14,7 +14,7 @@ public class BlockFetcherManagerController : MithrilControllerBase
       private readonly ILogger<ConsensusController> _logger;
       readonly IBlockFetcherManager _blockFetcherManager;
 
-      public BlockFetcherManagerController(ILogger<ConsensusController> logger, IEventBus eventBus, IBlockFetcherManager blockFetcherManager)
+      public BlockFetcherManagerController(ILogger<ConsensusController> logger, IBlockFetcherManager blockFetcherManager)
       {
          _logger = logger;
          _blockFetcherManager = blockFetcherManager;