Updated to version 8.4.1

CryptoExchange.Net.UnitTests/ExchangeHelpersTests.cs

@@ -1,6 +1,7 @@
 using CryptoExchange.Net.Objects;
 using NUnit.Framework;
 using NUnit.Framework.Legacy;
+using System.Diagnostics;
 using System.Globalization;
 
 namespace CryptoExchange.Net.UnitTests
@@ -70,5 +71,20 @@ namespace CryptoExchange.Net.UnitTests
             var result = ExchangeHelpers.Normalize(input);
             Assert.That(expected == result.ToString(CultureInfo.InvariantCulture));
         }
+
+        [Test]
+        [TestCase("123", "BKR", 32, true, "BKR|JK|123")]
+        [TestCase("123", "BKR", 32, false, "123")]
+        [TestCase("123123123123123123123123123123", "BKR", 32, true, "123123123123123123123123123123")] // 30
+        [TestCase("123123123123123123123123123", "BKR", 32, true, "123123123123123123123123123")] // 27
+        [TestCase("1231231231231231231231231", "BKR", 32, true, "BKR|JK|1231231231231231231231231")] // 25
+        [TestCase(null, "BKR", 32, true, null)]
+        public void ApplyBrokerIdTests(string clientOrderId, string brokerId, int maxLength, bool allowValueAdjustement, string expected)
+        {
+            var result = LibraryHelpers.ApplyBrokerId(clientOrderId, brokerId, maxLength, allowValueAdjustement);
+            
+            if (expected != null)
+                Assert.That(result, Is.EqualTo(expected));
+        }
     }
 }

CryptoExchange.Net/Converters/SystemTextJson/JsonConverterCtorAttribute.cs

@@ -0,0 +1,27 @@
+using System;
+using System.Text.Json.Serialization;
+
+namespace CryptoExchange.Net.Converters.SystemTextJson
+{
+    /// <summary>
+    /// Attribute for allowing specifying a JsonConverter with constructor parameters
+    /// </summary>
+    /// <typeparam name="T"></typeparam>
+    [AttributeUsage(AttributeTargets.Property)]
+    public class JsonConverterCtorAttribute<T> : JsonConverterAttribute where T : JsonConverter
+    {
+        private readonly object[] _parameters;
+
+        /// <summary>
+        /// ctor
+        /// </summary>
+        public JsonConverterCtorAttribute(params object[] parameters) => _parameters = parameters;
+
+        /// <inheritdoc />
+        public override JsonConverter CreateConverter(Type typeToConvert)
+        {
+            return (T)Activator.CreateInstance(typeof(T), _parameters);
+        }
+    }
+
+}

CryptoExchange.Net/Converters/SystemTextJson/ReplaceConverter.cs

@@ -0,0 +1,41 @@
+using System;
+using System.Linq;
+using System.Text.Json;
+using System.Text.Json.Serialization;
+
+namespace CryptoExchange.Net.Converters.SystemTextJson
+{
+    /// <summary>
+    /// Replace a value on a string property
+    /// </summary>
+    public class ReplaceConverter : JsonConverter<string>
+    {
+        private readonly (string ValueToReplace, string ValueToReplaceWith)[] _replacementSets;
+
+        /// <summary>
+        /// ctor
+        /// </summary>
+        public ReplaceConverter(params string[] replaceSets)
+        {
+            _replacementSets = replaceSets.Select(x =>
+            {
+                var split = x.Split(new string[] { "->" }, StringSplitOptions.None);
+                if (split.Length != 2)
+                    throw new ArgumentException("Invalid replacement config");
+                return (split[0], split[1]);
+            }).ToArray();
+        }
+
+        /// <inheritdoc />
+        public override string? Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options)
+        {
+            var value = reader.GetString();
+            foreach (var set in _replacementSets)
+                value = value?.Replace(set.ValueToReplace, set.ValueToReplaceWith);
+            return value;
+        }
+
+        /// <inheritdoc />
+        public override void Write(Utf8JsonWriter writer, string value, JsonSerializerOptions options) => writer.WriteStringValue(value);
+    }
+}

CryptoExchange.Net/CryptoExchange.Net.csproj

@@ -6,9 +6,9 @@
     <PackageId>CryptoExchange.Net</PackageId>
     <Authors>JKorf</Authors>
     <Description>CryptoExchange.Net is a base library which is used to implement different cryptocurrency (exchange) API's. It provides a standardized way of implementing different API's, which results in a very similar experience for users of the API implementations.</Description>
-    <PackageVersion>8.4.0</PackageVersion>
-    <AssemblyVersion>8.4.0</AssemblyVersion>
-    <FileVersion>8.4.0</FileVersion>
+    <PackageVersion>8.4.1</PackageVersion>
+    <AssemblyVersion>8.4.1</AssemblyVersion>
+    <FileVersion>8.4.1</FileVersion>
     <PackageRequireLicenseAcceptance>false</PackageRequireLicenseAcceptance>
     <PackageTags>OKX;OKX.Net;Mexc;Mexc.Net;Kucoin;Kucoin.Net;Kraken;Kraken.Net;Huobi;Huobi.Net;CoinEx;CoinEx.Net;Bybit;Bybit.Net;Bitget;Bitget.Net;Bitfinex;Bitfinex.Net;Binance;Binance.Net;CryptoCurrency;CryptoCurrency Exchange</PackageTags>
     <RepositoryType>git</RepositoryType>
@@ -20,7 +20,7 @@
     <GeneratePackageOnBuild>true</GeneratePackageOnBuild>
     <PackageReleaseNotes>https://github.com/JKorf/CryptoExchange.Net?tab=readme-ov-file#release-notes</PackageReleaseNotes>
     <Nullable>enable</Nullable>
-    <LangVersion>10.0</LangVersion>
+    <LangVersion>12.0</LangVersion>
     <PackageLicenseExpression>MIT</PackageLicenseExpression>
   </PropertyGroup>
   <ItemGroup>

CryptoExchange.Net/LibraryHelpers.cs

@@ -0,0 +1,47 @@
+using System;
+using System.Collections.Generic;
+using System.Text;
+
+namespace CryptoExchange.Net
+{
+    /// <summary>
+    /// Helpers for client libraries
+    /// </summary>
+    public static class LibraryHelpers
+    {
+        /// <summary>
+        /// Client order id seperator
+        /// </summary>
+        public const string ClientOrderIdSeperator = "|JK|";
+
+        /// <summary>
+        /// Apply broker id to a client order id
+        /// </summary>
+        /// <param name="clientOrderId"></param>
+        /// <param name="brokerId"></param>
+        /// <param name="maxLength"></param>
+        /// <param name="allowValueAdjustement"></param>
+        /// <returns></returns>
+        public static string ApplyBrokerId(string? clientOrderId, string brokerId, int maxLength, bool allowValueAdjustement)
+        {
+            var reservedLength = brokerId.Length + ClientOrderIdSeperator.Length;
+
+            if ((clientOrderId?.Length + reservedLength) > maxLength)
+                return clientOrderId!;
+
+            if (!string.IsNullOrEmpty(clientOrderId))
+            {
+                if (allowValueAdjustement)
+                    clientOrderId = brokerId + ClientOrderIdSeperator + clientOrderId;
+
+                return clientOrderId!;
+            }
+            else
+            {
+                clientOrderId = ExchangeHelpers.AppendRandomString(brokerId + ClientOrderIdSeperator, maxLength);
+            }
+
+            return clientOrderId;
+        }
+    }
+}

README.md

@@ -50,6 +50,11 @@ Make a one time donation in a crypto currency of your choice. If you prefer to d
 Alternatively, sponsor me on Github using [Github Sponsors](https://github.com/sponsors/JKorf). 
 
 ## Release notes
+* Version 8.4.1 - 02 Dec 2024
+    * Added JsonConverterCtorAttribute to allow specifying a custom JsonConverter with constructor parameters on properties
+    * Added ReplaceConverter System.Text.Json converter
+    * Added LibraryHelpers class for internal helper methods
+
 * Version 8.4.0 - 28 Nov 2024
     * Added GetFeesAsync Shared REST client support
     * Added LibraryOptions base class