v0.9.0: extensibility via TonClient.RegisterAssembly

Author: justdmitry

TonLibDotNet.Demo/ExtensibilityDemoRequest.cs

@@ -0,0 +1,12 @@
+using TonLibDotNet.Requests;
+using TonLibDotNet.Types;
+using TonLibDotNet.Utils;
+
+namespace TonLibDotNet
+{
+    [TLSchema("hello.world = hello.World")]
+    public class ExtensibilityDemoRequest : RequestBase<Ok>
+    {
+        public string Continent { get; set; } = string.Empty;
+    }
+}

TonLibDotNet.Demo/Program.cs

@@ -36,6 +36,9 @@ public static async Task Main(string[] args)
                 services.AddSingleton<ITonClient, TonClient>();
             });
 
+            /// Add types from current assembly (see <see cref="ExtensibilityDemoRequest"/> class and <see cref="RunExtensibilityDemo(ITonClient)" below />).
+            TonClient.RegisterAssembly(typeof(Program).Assembly);
+
             var app = builder.Build();
 
             var logger = app.Services.GetRequiredService<ILoggerFactory>().CreateLogger(nameof(Program));
@@ -59,6 +62,8 @@ public static async Task Main(string[] args)
                 await RunSendDemo(tonClient, logger, TestnetAccountToSendFromAddress, TestnetAccountToSendFromMnemonic);
             }
 
+            await RunExtensibilityDemo(tonClient, logger);
+
             // Loggers need some time to flush data to screen/console.
             await Task.Delay(TimeSpan.FromSeconds(1));
         }
@@ -170,5 +175,21 @@ private static async Task RunSendDemo(ITonClient tonClient, ILogger logger, stri
             // Send it to network. You dont have TX id or something in respnse - just poll getTransactions() for your account and wait for new TX.
             _ = await tonClient.QuerySend(query.Id);
         }
+
+        private static async Task RunExtensibilityDemo(ITonClient tonClient, ILogger logger)
+        {
+            // This will fail because TonLib does not have this method.
+            // This is just a demo how you can add new types/requests without waiting for new package release.
+            // To make this happen in your app - call TonClient.RegisterAssembly() early
+            try
+            {
+                await tonClient.Execute(new ExtensibilityDemoRequest() { Continent = "Antarctica" });
+            }
+            catch (TonClientException ex)
+            {
+                logger.LogWarning(ex, "Exception ignored");
+                // Ignore
+            }
+        }
     }
 }

TonLibDotNet/TonClient.cs

@@ -50,6 +50,15 @@ public TonClient(ILogger<TonClient> logger, Microsoft.Extensions.Options.IOption
 
         public OptionsInfo OptionsInfo { get; private set; }
 
+        /// <summary>
+        /// Add assembly with additional <see cref="TypeBase"/> classes for LiteServer interaction.
+        /// </summary>
+        /// <param name="assembly">Assembly to add</param>
+        public static void RegisterAssembly(System.Reflection.Assembly assembly)
+        {
+            TonLibDotNet.Utils.Json.TonTypeResolver.AdditionalAsseblies.Add(assembly);
+        }
+
         public async Task<OptionsInfo?> InitIfNeeded()
         {
             if (needReinit)

TonLibDotNet/TonLibDotNet.csproj

@@ -16,8 +16,8 @@
     <RepositoryType>git</RepositoryType>
     <PackageTags>ton, tonlib, libtonlibjson</PackageTags>
     <PackageLicenseFile>LICENSE</PackageLicenseFile>
-    <Version>0.8.0</Version>
-    <PackageReleaseNotes>Added methods sending TON.</PackageReleaseNotes>
+    <Version>0.9.0</Version>
+    <PackageReleaseNotes>Extensibility: register new types/requests from other assemblies.</PackageReleaseNotes>
     <Description>TonLib (libtonlibjson) wrapper for accessing Telegram Open Network lite servers (nodes) via ADNL protocol.</Description>
   </PropertyGroup>
 

TonLibDotNet/Utils/Json/TonTypeResolver.cs

@@ -8,6 +8,8 @@ namespace TonLibDotNet.Utils.Json
     // Based on https://learn.microsoft.com/en-us/dotnet/standard/serialization/system-text-json/polymorphism?pivots=dotnet-7-0#configure-polymorphism-with-the-contract-model
     public class TonTypeResolver : DefaultJsonTypeInfoResolver
     {
+        public static List<Assembly> AdditionalAsseblies { get; } = new List<Assembly>();
+
         public override JsonTypeInfo GetTypeInfo(Type type, JsonSerializerOptions options)
         {
             var jsonTypeInfo = base.GetTypeInfo(type, options);
@@ -29,13 +31,14 @@ public override JsonTypeInfo GetTypeInfo(Type type, JsonSerializerOptions option
 
         protected void AppendTypes(Type type, IList<JsonDerivedType> list)
         {
-            var types = GetType().Assembly.GetExportedTypes()
-                .Where(x => x.IsAssignableTo(type) && !x.IsAbstract)
-                .Select(x => new
-                {
-                    type = x,
-                    schema = x.GetCustomAttribute<TLSchemaAttribute>(false),
-                });
+            var types = AdditionalAsseblies.Append(GetType().Assembly)
+                .SelectMany(a => a.GetExportedTypes()
+                    .Where(x => x.IsAssignableTo(type) && !x.IsAbstract)
+                    .Select(x => new
+                    {
+                        type = x,
+                        schema = x.GetCustomAttribute<TLSchemaAttribute>(false),
+                    }));
 
             foreach (var item in types.Where(x => x.schema != null))
             {