Code cleanup

Update xml docs

Author: Serhii Yolkin

UnityProject/Assets/LoomSDK/Source/Runtime/Address.cs

@@ -61,7 +61,7 @@ private Address(byte[] publicKey, string chainId = DefaultChainId)
  }
 
  /// <summary>
- /// Returns binary 20-byte array representing of the address.
+ /// Returns binary 20-byte array representation of the address.
  /// </summary>
  /// <returns>20-byte array containing the address.</returns>
  public byte[] ToByteArray()
@@ -116,6 +116,12 @@ public static Address FromProtobufAddress(Protobuf.Address protobufAddress)
  String.IsNullOrWhiteSpace(protobufAddress.ChainId) ? DefaultChainId : protobufAddress.ChainId);
  }
 
+ /// <summary>
+ /// Creates an Address instance from a byte array.
+ /// </summary>
+ /// <param name="address">binary 20-byte array representation of the address</param>
+ /// <param name="chainId">Identifier of a DAppChain.</param>
+ /// <returns>An address</returns>
  public static Address FromBytes(byte[] address, string chainId = DefaultChainId)
  {
  if (address == null)

UnityProject/Assets/LoomSDK/Source/Runtime/DAppChainClient.cs

@@ -19,7 +19,7 @@ namespace Loom.Client
  /// <summary>
  /// Writes to & reads from a Loom DAppChain.
  /// </summary>
- public class DAppChainClient : IDisposable
+ public class DAppChainClient : IDAppChainClientConfigurationProvider, IDisposable
  {
  private const string LogTag = "Loom.DAppChainClient";
 
@@ -46,6 +46,9 @@ public class DAppChainClient : IDisposable
  /// </summary>
  public TxMiddleware TxMiddleware { get; set; }
 
+ /// <summary>
+ /// Client options container.
+ /// </summary>
  public DAppChainClientConfiguration Configuration { get; }
 
  public IDAppChainClientCallExecutor CallExecutor { get; }
@@ -91,12 +94,14 @@ public event EventHandler<RawChainEventArgs> ChainEventReceived
  /// <param name="writeClient">RPC client to use for submitting transactions.</param>
  /// <param name="readClient">RPC client to use for querying DAppChain state.</param>
  /// <param name="configuration">Client configuration structure.</param>
- public DAppChainClient(IRpcClient writeClient, IRpcClient readClient, DAppChainClientConfiguration configuration = null)
+ /// <param name="callExecutor">Blockchain call execution flow controller.</param>
+ public DAppChainClient(IRpcClient writeClient, IRpcClient readClient, DAppChainClientConfiguration configuration = null, IDAppChainClientCallExecutor callExecutor = null)
  {
  this.writeClient = writeClient;
  this.readClient = readClient;
- Configuration = configuration ?? new DAppChainClientConfiguration();
- this.CallExecutor = new DefaultDAppChainClientCallExecutor(Configuration);
+
+ this.Configuration = configuration ?? new DAppChainClientConfiguration();
+ this.CallExecutor = callExecutor ?? new DefaultDAppChainClientCallExecutor(this);
  }
 
  public void Dispose()

UnityProject/Assets/LoomSDK/Source/Runtime/DAppChainClientBuilder.cs

@@ -0,0 +1,96 @@
+using System;
+using UnityEngine;
+
+namespace Loom.Client
+{
+ /// <summary>
+ /// Builds an instance of <see cref="DAppChainClient"/>.
+ /// </summary>
+ public class DAppChainClientBuilder
+ {
+ private IRpcClient reader;
+ private IRpcClient writer;
+ private ILogger logger;
+ private DAppChainClientConfiguration configuration;
+ private TxMiddleware txMiddleware;
+ private IDAppChainClientCallExecutor callExecutor;
+
+ public DAppChainClientBuilder()
+ {
+ }
+
+ public static DAppChainClientBuilder Configure()
+ {
+ return new DAppChainClientBuilder();
+ }
+
+ public DAppChainClientBuilder WithWriter(IRpcClient writer)
+ {
+ if (writer == null)
+ throw new ArgumentNullException(nameof(writer));
+
+ this.writer = writer;
+ return this;
+ }
+
+ public DAppChainClientBuilder WithReader(IRpcClient reader)
+ {
+ if (reader == null)
+ throw new ArgumentNullException(nameof(reader));
+
+ this.reader = reader;
+ return this;
+ }
+
+ public DAppChainClientBuilder WithTxMiddleware(TxMiddleware txMiddleware)
+ {
+ if (txMiddleware == null)
+ throw new ArgumentNullException(nameof(txMiddleware));
+
+ this.txMiddleware = txMiddleware;
+ return this;
+ }
+
+ public DAppChainClientBuilder WithCallExecutor(IDAppChainClientCallExecutor callExecutor)
+ {
+ if (callExecutor == null)
+ throw new ArgumentNullException(nameof(callExecutor));
+
+ this.callExecutor = callExecutor;
+ return this;
+ }
+
+ public DAppChainClientBuilder WithConfiguration(DAppChainClientConfiguration configuration)
+ {
+ this.configuration = configuration;
+ return this;
+ }
+
+ public DAppChainClientBuilder WithLogger(ILogger logger)
+ {
+ this.logger = logger;
+ return this;
+ }
+
+ public DAppChainClient Create()
+ {
+ DAppChainClientConfiguration configuration = this.configuration ?? new DAppChainClientConfiguration();
+ IDAppChainClientCallExecutor callExecutor =
+ this.callExecutor ?? new DefaultDAppChainClientCallExecutor(
+ new DAppChainClientConfigurationProvider
+ {
+ Configuration = this.configuration
+ });
+ return new DAppChainClient(this.writer, this.reader, configuration, callExecutor)
+ {
+ TxMiddleware = this.txMiddleware,
+ Logger = this.logger ?? NullLogger.Instance
+ };
+ }
+
+ private class DAppChainClientConfigurationProvider : IDAppChainClientConfigurationProvider
+ {
+ public DAppChainClientConfiguration Configuration { get; set; }
+ }
+ }
+}

UnityProject/Assets/LoomSDK/Source/Runtime/DAppChainClientBuilder.cs.meta

@@ -27,4 +27,12 @@ public sealed class DAppChainClientConfiguration
  /// </summary>
  public int InvalidNonceTxRetries { get; set; } = 5;
  }
+
+ /// <summary>
+ /// Represents an entity that stores a <see cref="DAppChainClientConfiguration"/>.
+ /// </summary>
+ public interface IDAppChainClientConfigurationProvider
+ {
+ DAppChainClientConfiguration Configuration { get; }
+ }
 }

UnityProject/Assets/LoomSDK/Source/Runtime/DAppChainClientConfiguration.cs

@@ -6,22 +6,29 @@
 
 namespace Loom.Client
 {
+ /// <summary>
+ /// Default call executor provides handling for general blockchain situations.
+ /// 1. Calls throw a <see cref="TimeoutException"/> if the calls receives no response for too long.
+ /// 2. If the blockchain
+ /// </summary>
  public class DefaultDAppChainClientCallExecutor : IDAppChainClientCallExecutor
  {
  private readonly AsyncSemaphore callAsyncSemaphore = new AsyncSemaphore(1);
+ private readonly IDAppChainClientConfigurationProvider configurationProvider;
 
- public DAppChainClientConfiguration Configuration { get; }
-
- public DefaultDAppChainClientCallExecutor(DAppChainClientConfiguration configuration)
+ public DefaultDAppChainClientCallExecutor(IDAppChainClientConfigurationProvider configurationProvider)
  {
- this.Configuration = configuration;
+ if (configurationProvider == null)
+ throw new ArgumentNullException(nameof(configurationProvider));
+
+ this.configurationProvider = configurationProvider;
  }
 
  public async Task<T> Call<T>(Func<Task<T>> taskProducer)
  {
  Task<T> task = (Task<T>) await ExecuteTaskWithRetryOnInvalidTxNonceException(
  () => ExecuteTaskWaitForOtherTasks(
- () => ExecuteTaskWithTimeout(taskProducer, this.Configuration.CallTimeout)
+ () => ExecuteTaskWithTimeout(taskProducer, this.configurationProvider.Configuration.CallTimeout)
  ));
 
  return await task;
@@ -31,7 +38,7 @@ public async Task Call(Func<Task> taskProducer)
  {
  Task task = await ExecuteTaskWithRetryOnInvalidTxNonceException(
  () => ExecuteTaskWaitForOtherTasks(
- () => ExecuteTaskWithTimeout(taskProducer, this.Configuration.CallTimeout)
+ () => ExecuteTaskWithTimeout(taskProducer, this.configurationProvider.Configuration.CallTimeout)
  ));
 
  await task;
@@ -40,7 +47,7 @@ public async Task Call(Func<Task> taskProducer)
  public async Task<T> StaticCall<T>(Func<Task<T>> taskProducer)
  {
  Task<T> task = (Task<T>) await ExecuteTaskWaitForOtherTasks(
- () => ExecuteTaskWithTimeout(taskProducer, this.Configuration.StaticCallTimeout)
+ () => ExecuteTaskWithTimeout(taskProducer, this.configurationProvider.Configuration.StaticCallTimeout)
  );
 
  return await task;
@@ -49,21 +56,21 @@ public async Task<T> StaticCall<T>(Func<Task<T>> taskProducer)
  public async Task StaticCall(Func<Task> taskProducer)
  {
  Task task = await ExecuteTaskWaitForOtherTasks(
- () => ExecuteTaskWithTimeout(taskProducer, this.Configuration.StaticCallTimeout)
+ () => ExecuteTaskWithTimeout(taskProducer, this.configurationProvider.Configuration.StaticCallTimeout)
  );
 
  await task;
  }
 
  public async Task<T> NonBlockingStaticCall<T>(Func<Task<T>> taskProducer)
  {
- Task<T> task = (Task<T>) await ExecuteTaskWithTimeout(taskProducer, this.Configuration.StaticCallTimeout);
+ Task<T> task = (Task<T>) await ExecuteTaskWithTimeout(taskProducer, this.configurationProvider.Configuration.StaticCallTimeout);
  return await task;
  }
 
  public async Task NonBlockingStaticCall(Func<Task> taskProducer)
  {
- Task task = await ExecuteTaskWithTimeout(taskProducer, this.Configuration.StaticCallTimeout);
+ Task task = await ExecuteTaskWithTimeout(taskProducer, this.configurationProvider.Configuration.StaticCallTimeout);
  await task;
  }
 
@@ -136,7 +143,9 @@ private async Task<Task> ExecuteTaskWithRetryOnInvalidTxNonceException(Func<Task
 #else
  await Task.Delay(TimeSpan.FromSeconds(delay));
 #endif
- } while (this.Configuration.InvalidNonceTxRetries != 0 && badNonceCount <= this.Configuration.InvalidNonceTxRetries);
+ } while (
+ this.configurationProvider.Configuration.InvalidNonceTxRetries != 0 &&
+ badNonceCount <= this.configurationProvider.Configuration.InvalidNonceTxRetries);
 
  throw new InvalidTxNonceException(1, "sequence number does not match");
  }

UnityProject/Assets/LoomSDK/Source/Runtime/DefaultDAppChainClientCallExecutor.cs

@@ -36,11 +36,30 @@ public EvmContract(DAppChainClient client, Address contractAddress, Address call
  }
  }
 
+ /// <summary>
+ /// Gets an instance of <see cref="EvmEvent"/> set up for working with Solidity event named <paramref name="name"/>.
+ /// </summary>
+ /// <param name="name">Solidity event name.</param>
  public EvmEvent GetEvent(string name)
  {
  return new EvmEvent(this, this.contractBuilder.GetEventBuilder(name));
  }
 
+ /// <summary>
+ /// Gets an instance of <see cref="EvmEvent{T}"/> set up for working with Solidity event named <paramref name="name"/>.
+ /// </summary>
+ /// <param name="name">Solidity event name.</param>
+ /// <typeparam name="T">Event DTO type.</typeparam>
+ /// <see href="https://nethereum.readthedocs.io/en/latest/contracts/calling-transactions-events/"/>
+ public EvmEvent<T> GetEvent<T>(string name) where T : new()
+ {
+ return new EvmEvent<T>(this, this.contractBuilder.GetEventBuilder(name));
+ }
+
+ /// <summary>
+ /// Retrieves the current block height.
+ /// </summary>
+ /// <returns></returns>
  public async Task<BigInteger> GetBlockHeight()
  {
  return await this.Client.CallExecutor.StaticCall(