Merge branch 'master' into vo/client-gen-dotnet

net/Directory.Packages.props

@@ -5,7 +5,6 @@
   </PropertyGroup>
   <ItemGroup>
     <PackageVersion Include="Ensure.That" Version="10.1.0" />
-    <PackageVersion Include="IsExternalInit" Version="1.0.3" />
     <PackageVersion Include="Microsoft.CodeAnalysis.Analyzers" Version="3.11.0">
       <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
       <PrivateAssets>all</PrivateAssets>
@@ -14,7 +13,7 @@
       <PrivateAssets>all</PrivateAssets>
     </PackageVersion>
     <PackageVersion Include="Microsoft.Extensions.DependencyInjection.Abstractions" Version="8.0.2" />
-    <PackageVersion Include="RequiredMemberAttribute" Version="1.0.0" />
+    <PackageVersion Include="PolySharp" Version="1.14.1" />
     <PackageVersion Include="Roslynator.Analyzers" Version="4.12.8" />
     <PackageVersion Include="Roslynator.Formatting.Analyzers" Version="4.12.8" />
     <PackageVersion Include="Substrate.NET.API" Version="0.9.24-rc6" />

net/src/Sails.Remoting.Abstractions/IRemoting.cs

@@ -9,21 +9,49 @@ namespace Sails.Remoting.Abstractions;
 
 public interface IRemoting
 {
-    Task<(ActorId ProgramId, byte[] EncodedReply)> ActivateAsync(
+    /// <summary>
+    /// Activates/creates a program from previously uploaded code.
+    /// </summary>
+    /// <param name="codeId"></param>
+    /// <param name="salt"></param>
+    /// <param name="encodedPayload"></param>
+    /// <param name="gasLimit"></param>
+    /// <param name="value"></param>
+    /// <param name="cancellationToken"></param>
+    /// <returns>A task for obtaining activated program ID and SCALE-encoded reply.</returns>
+    Task<Task<(ActorId ProgramId, byte[] EncodedReply)>> ActivateAsync(
         CodeId codeId,
         IReadOnlyCollection<byte> salt,
         IReadOnlyCollection<byte> encodedPayload,
         GasUnit? gasLimit,
         ValueUnit value,
         CancellationToken cancellationToken);
 
-    Task<byte[]> MessageAsync(
+    /// <summary>
+    /// Sends a message to a program for execution.
+    /// </summary>
+    /// <param name="programId"></param>
+    /// <param name="encodedPayload"></param>
+    /// <param name="gasLimit"></param>
+    /// <param name="value"></param>
+    /// <param name="cancellationToken"></param>
+    /// <returns>A task for obtaining SCALE-encoded reply.</returns>
+    Task<Task<byte[]>> MessageAsync(
         ActorId programId,
         IReadOnlyCollection<byte> encodedPayload,
         GasUnit? gasLimit,
         ValueUnit value,
         CancellationToken cancellationToken);
 
+    /// <summary>
+    /// Queries a program for information.
+    /// </summary>
+    /// <param name="programId"></param>
+    /// <param name="encodedPayload"></param>
+    /// <param name="gasLimit"></param>
+    /// <param name="value"></param>
+    /// <param name="cancellationToken"></param>
+    /// <returns>SCALE-encoded reply.</returns>
     Task<byte[]> QueryAsync(
         ActorId programId,
         IReadOnlyCollection<byte> encodedPayload,

net/src/Sails.Remoting.Abstractions/IRemotingExtensions.cs

@@ -1,15 +1,17 @@
-using Substrate.Gear.Api.Generated.Model.gprimitives;
-using System.Collections.Generic;
-using System.Threading.Tasks;
+using System.Collections.Generic;
 using System.Threading;
+using System.Threading.Tasks;
 using EnsureThat;
+using Substrate.Gear.Api.Generated.Model.gprimitives;
+using GasUnit = Substrate.NetApi.Model.Types.Primitive.U64;
 using ValueUnit = Substrate.NetApi.Model.Types.Primitive.U128;
 
 namespace Sails.Remoting.Abstractions;
 
 public static class IRemotingExtensions
 {
-    public static Task<(ActorId ProgramId, byte[] EncodedReply)> ActivateAsync(
+    /// <inheritdoc cref="IRemoting.ActivateAsync(CodeId, IReadOnlyCollection{byte}, IReadOnlyCollection{byte}, GasUnit?, ValueUnit, CancellationToken)"/>
+    public static Task<Task<(ActorId ProgramId, byte[] EncodedReply)>> ActivateAsync(
         this IRemoting remoting,
         CodeId codeId,
         IReadOnlyCollection<byte> salt,
@@ -24,7 +26,8 @@ public static class IRemotingExtensions
                 ZeroValue,
                 cancellationToken);
 
-    public static Task<byte[]> MessageAsync(
+    /// <inheritdoc cref="IRemoting.MessageAsync(ActorId, IReadOnlyCollection{byte}, GasUnit?, ValueUnit, CancellationToken)"/>
+    public static Task<Task<byte[]>> MessageAsync(
         this IRemoting remoting,
         ActorId programId,
         IReadOnlyCollection<byte> encodedPayload,
@@ -37,6 +40,7 @@ public static Task<byte[]> MessageAsync(
                 ZeroValue,
                 cancellationToken);
 
+    /// <inheritdoc cref="IRemoting.QueryAsync(ActorId, IReadOnlyCollection{byte}, GasUnit?, ValueUnit, CancellationToken)"/>
     public static Task<byte[]> QueryAsync(
         this IRemoting remoting,
         ActorId programId,

net/src/Sails.Remoting.Abstractions/IRemotingProvider.cs

@@ -0,0 +1,14 @@
+using Substrate.NetApi.Model.Types;
+
+namespace Sails.Remoting.Abstractions;
+
+public interface IRemotingProvider
+{
+    /// <summary>
+    /// Creates an instance implementing the <see cref="IRemoting"/> interface
+    /// with initial account for signing transactions.
+    /// </summary>
+    /// <param name="signingAccount"></param>
+    /// <returns></returns>
+    IRemoting CreateRemoting(Account signingAccount);
+}

net/src/Sails.Remoting/DependencyInjection/IServiceCollectionExtensions.cs

@@ -7,16 +7,20 @@ namespace Sails.Remoting.DependencyInjection;
 
 public static class IServiceCollectionExtensions
 {
-    public static IServiceCollection AddRemotingViaSubstrateClient(
+    public static IServiceCollection AddRemotingViaNodeClient(
         this IServiceCollection services,
-        RemotingViaSubstrateClientOptions options)
+        NodeClientOptions options)
     {
         EnsureArg.IsNotNull(services, nameof(services));
         EnsureArg.IsNotNull(options, nameof(options));
 
-        services.AddSingleton(options);
+        services.AddSingleton<INodeClientProvider>(_ => new NodeClientProvider(options));
 
-        services.AddTransient<IRemoting, RemotingViaSubstrateClient>();
+        services.AddTransient<IRemotingProvider>(
+            serviceProvicer => new RemotingProvider(
+                signingAccount => new RemotingViaNodeClient(
+                    serviceProvicer.GetRequiredService<INodeClientProvider>(),
+                    signingAccount)));
 
         return services;
     }

net/src/Sails.Remoting/INodeClientProvider.cs

@@ -0,0 +1,15 @@
+using System.Threading;
+using System.Threading.Tasks;
+using Substrate.Gear.Api.Generated;
+
+namespace Sails.Remoting;
+
+internal interface INodeClientProvider
+{
+    /// <summary>
+    /// Returns connected node client.
+    /// </summary>
+    /// <param name="cancellationToken"></param>
+    /// <returns></returns>
+    Task<SubstrateClientExt> GetNodeClientAsync(CancellationToken cancellationToken);
+}

net/src/Sails.Remoting/NodeClientProvider.cs

@@ -0,0 +1,36 @@
+using System;
+using System.Threading;
+using System.Threading.Tasks;
+using EnsureThat;
+using Sails.Remoting.Options;
+using Substrate.Gear.Api.Generated;
+using Substrate.NetApi.Model.Extrinsics;
+
+namespace Sails.Remoting;
+
+internal sealed class NodeClientProvider : IDisposable, INodeClientProvider
+{
+    public NodeClientProvider(NodeClientOptions options)
+    {
+        EnsureArg.IsNotNull(options, nameof(options));
+        EnsureArg.IsNotNull(options.GearNodeUri, nameof(options.GearNodeUri));
+
+        this.nodeClient = new SubstrateClientExt(options.GearNodeUri, ChargeTransactionPayment.Default());
+    }
+
+    private readonly SubstrateClientExt nodeClient;
+
+    /// <inheritdoc/>
+    public void Dispose()
+    {
+        this.nodeClient.Dispose();
+        GC.SuppressFinalize(this);
+    }
+
+    /// <inheritdoc/>
+    public async Task<SubstrateClientExt> GetNodeClientAsync(CancellationToken cancellationToken)
+    {
+        await this.nodeClient.ConnectAsync(cancellationToken).ConfigureAwait(false);
+        return this.nodeClient;
+    }
+}

net/src/Sails.Remoting/Options/RemotingViaSubstrateClientOptions.cs → net/src/Sails.Remoting/Options/NodeClientOptions.cs

@@ -2,7 +2,7 @@
 
 namespace Sails.Remoting.Options;
 
-public sealed record RemotingViaSubstrateClientOptions
+public sealed record NodeClientOptions
 {
     public Uri? GearNodeUri { get; init; }
 }

net/src/Sails.Remoting/RemotingProvider.cs

@@ -0,0 +1,26 @@
+using System;
+using EnsureThat;
+using Sails.Remoting.Abstractions;
+using Substrate.NetApi.Model.Types;
+
+namespace Sails.Remoting;
+
+internal sealed class RemotingProvider : IRemotingProvider
+{
+    public RemotingProvider(Func<Account, IRemoting> remotingFactory)
+    {
+        EnsureArg.IsNotNull(remotingFactory, nameof(remotingFactory));
+
+        this.remotingFactory = remotingFactory;
+    }
+
+    private readonly Func<Account, IRemoting> remotingFactory;
+
+    /// <inheritdoc/>
+    public IRemoting CreateRemoting(Account signingAccount)
+    {
+        EnsureArg.IsNotNull(signingAccount, nameof(signingAccount));
+
+        return this.remotingFactory(signingAccount);
+    }
+}