1
0
mirror of https://github.com/JKorf/CryptoExchange.Net.git synced 2026-10-14 15:11:44 +00:00
Files
CryptoExchange.Net/CryptoExchange.Net/SharedApis/Models/ExchangeParameters.cs
T
Jan Korf e823114623 CryptoExchange V12 (#281)
* Result types:
  * (Web)CallResult types are replaced by HttpResult, WebSocketResult and QueryResult with the same logic
  * Updated result types to record type
  * Result creation can be done with (Http/WebSocket/Query)Result.Ok(..) and .Fail(..)
  * Removed implicit result type conversion to bool, `if (result)` no longer works, instead use `if (result.Success)`
  * Replaced CallResult.SuccessResult with CallResult.Ok()
  * Fixed result object nullability hinting, for example Data might be null if Success isn't checked for true

* Parameters & serialization:
  * Added support for `enabled` and `disabled` strings to bool converter
  * Removed ParameterCollection type, has been replaced by Parameters type
  * Removed ArraySerialization, OrderParameters and ParameterOrderComparer properties from RestApiClient, moved to ParameterSerializationsSettings
  * Updated RestRequestConfiguration in AuthenticationProvider.ProcessRequest to contain the full RequestDefinition instead of copied fields	

* Clients:
  * Updated Api client constructor logging parameter from ILogger to ILoggerFactory? 
  * Added Api client constructor exchange name parameter
  * Added ToString overrides on base API types
  * Added Exchange property on BaseApiClient
  * Added ApiCredentials property on IRestApiClient and ISocketApiClient interfaces
  * Updated ILogger source from client name to topic specific client name
  * Removed logging from client creation
  * Fixed BaseRestClient SetApiCredentials not marked as virtual

* Rest:
  * Added BaseAddress to RequestDefinition object
  * Updated RestApiClient AuthenticationProvider logic from private to protected and virtual
  * Removed RestApiClient.SendAsync baseAddress parameter removed
  * Removed RestApiClient.SendAsync without type parameter

* WebSocket:
  * Updated MessageRouting definition into CreateForEvent for subscriptions and CreateForQuery for queries
  * Improved Query type safety with CeateForQuery which allows second parameter for specifying the result type
  * Renamed MessageRouter.CreateWithoutHandler to CreateVoid
  * Updated SocketApiClient.GetSocketConnection to check connection uri instead of Tag for finding compatible connections
  * Removed unused UnhandledMessageExpected property SocketApiClient
  * Fixed issue in SocketApiClient.GetSocketConnection causing requests to always wait the full max 10 seconds when there was a reconnecting socket
	
* Shared APIs:
  * Updated Option definitions to always require the exchange name as first parameter
  * Added missing dedicated option types
  * Added Discover method on ISharedClient interface, returning info on supported capabilities and operations
  * Added SharedRequest GetParamValue helper method accepting multiple parameter names
  * Added ResetStaticExchangeParameters method on ExchangeParameters
  * Added Status property to SharedWithdrawal model
  * Added TradingModes property to SharedBalance model
  * Updated ExchangeSymbolCache to support multiple environments and additional key separation
  * Updated Shared ExchangeParameters parameter names to be case insensitive
  * Updated code comments
  * Replaced ExchangeResult with ExchangeCallResult type
  * Removed AsExchangeResult/ExchangeWebResult
  * Removed TradingMode from the response model, only maintained on models where it makes sense
  * Removed IListenKey support, listen keys now rely on internal management with TokenManager

* Rate limiting:
  * Fixed websocket connection attempts counting towards rate limit even when server could not be reached
  * Removed host from rate limit methods, now part of the already provided RequestDefinition
  * Added amount parameter to RateLimit Reset method to allow partially resetting the limit

* Added TokenManager implementation for automatic listenkey/token management
* Added UserClientProvider base class
* Added async streaming on UserDataTracker items with StreamUpdatesAsync
* Added cancellation token support to UserDataTracker starting
* Added Unit type for non-result types
* Added ServerError constructor taking ErrorType and message to make it easier to create
* Added SupportedEnvironments property to PlatformInfo
* Updated SymbolOrderBook DoResyncAsync to return CallResult instead of CallResult<bool> which was redundant
* Various small performance improvements
2026-06-29 10:38:09 +02:00

216 lines
8.2 KiB
C#

using CryptoExchange.Net.Objects;
using System;
using System.Collections.Generic;
using System.Data.Common;
using System.Linq;
namespace CryptoExchange.Net.SharedApis
{
/// <summary>
/// Exchange parameters
/// </summary>
public class ExchangeParameters
{
private readonly static Dictionary<string, Parameters> _staticProcessParameters = new Dictionary<string, Parameters>();
private readonly Dictionary<string, Parameters> _processParameters;
/// <summary>
/// Create a new ExchangeParameters instance with the provided parameters set
/// </summary>
/// <param name="parameters">Exchange parameters</param>
public ExchangeParameters(params ExchangeParameter[] parameters)
{
_processParameters = new Dictionary<string, Parameters>();
foreach (var parameter in parameters)
AddValue(parameter.Exchange, parameter.Name, parameter.Value);
}
/// <summary>
/// Add a process parameter. Process parameters are used to determine the correct logic to execute, but are not necessarily passed to the API.<br />
/// To directly add or override parameters which are passed to the API, use AddRawParameter or AddRawValue instead.
/// </summary>
/// <param name="exchangeParameter">The exchange parameter to add</param>
public void AddValue(ExchangeParameter exchangeParameter)
{
AddValue(exchangeParameter.Exchange, exchangeParameter.Name, exchangeParameter.Value);
}
/// <summary>
/// Add a process parameter. Process parameters are used to determine the correct logic to execute, but are not necessarily passed to the API.<br />
/// To directly add or override parameters which are passed to the API, use AddRawParameter or AddRawValue instead.
/// </summary>
/// <param name="exchange">Exchange to apply the parameter for</param>
/// <param name="key">Parameter name</param>
/// <param name="value">Parameter value</param>
public void AddValue(string exchange, string key, object value)
{
if (!_processParameters.TryGetValue(exchange, out var exchangeParameters))
{
exchangeParameters = new Parameters(ParameterSerializationSettings.Default);
_processParameters[exchange] = exchangeParameters;
}
exchangeParameters.AddRaw(key, value);
}
/// <summary>
/// Check whether a specific parameter is provided in this specific instance
/// </summary>
/// <param name="exchange">The exchange name</param>
/// <param name="name">Parameter name</param>
/// <param name="type">Type of the parameter value</param>
/// <returns></returns>
public bool HasValue(string exchange, string name, Type type)
{
var val = TryGetValue(_processParameters, exchange, name);
val ??= TryGetValue(_staticProcessParameters, exchange, name);
if (val == null)
return false;
try
{
Type t = Nullable.GetUnderlyingType(type) ?? type;
Convert.ChangeType(val, t);
return true;
}
catch
{
return false;
}
}
/// <summary>
/// Check whether a specific process parameter is provided in the default parameters or the provided instance
/// </summary>
/// <param name="exchangeParameters">The provided exchange parameter in the request</param>
/// <param name="exchange">The exchange name</param>
/// <param name="name">Parameter name</param>
/// <param name="type">Type of the parameter value</param>
/// <returns></returns>
public static bool HasValue(ExchangeParameters? exchangeParameters, string exchange, string name, Type type)
{
var provided = exchangeParameters?.HasValue(exchange, name, type);
if (provided == true)
return true;
var val = TryGetValue(_staticProcessParameters, exchange, name);
if (val == null)
return false;
try
{
Type t = Nullable.GetUnderlyingType(type) ?? type;
Convert.ChangeType(val, t);
return true;
}
catch
{
return false;
}
}
/// <summary>
/// Get the value of a parameter from this instance
/// </summary>
/// <typeparam name="T">Type of the parameter value</typeparam>
/// <param name="exchange">Exchange name</param>
/// <param name="name">Parameter name</param>
public T? GetValue<T>(string exchange, string name)
{
var val = TryGetValue(_processParameters, exchange, name);
val ??= TryGetValue(_staticProcessParameters, exchange, name);
if (val == null)
return default;
if (val is T typeVal)
return typeVal;
try
{
Type t = Nullable.GetUnderlyingType(typeof(T)) ?? typeof(T);
return (T)Convert.ChangeType(val, t);
}
catch
{
throw new ArgumentException("Incorrect type for parameter, expected " + typeof(T).Name, name);
}
}
/// <summary>
/// Get the value of a parameter from this instance or the default values
/// </summary>
/// <typeparam name="T">Type of the parameter value</typeparam>
/// <param name="exchangeParameters">The request parameters</param>
/// <param name="exchange">Exchange name</param>
/// <param name="name">Parameter name</param>
public static T? GetValue<T>(ExchangeParameters? exchangeParameters, string exchange, string name)
{
if (exchangeParameters != null) {
var provided = exchangeParameters.GetValue<T>(exchange, name);
if (provided != null)
return provided;
}
var val = TryGetValue(_staticProcessParameters, exchange, name);
if (val == null)
return default;
try
{
var type = typeof(T);
Type t = Nullable.GetUnderlyingType(type) ?? type;
var result = Convert.ChangeType(val, t);
return (T)result;
}
catch
{
throw new ArgumentException("Incorrect type for parameter, expected " + typeof(T).Name, name);
}
}
/// <summary>
/// Set static parameters
/// </summary>
/// <param name="exchange">Exchange name</param>
/// <param name="key">Parameter name</param>
/// <param name="value">Parameter value</param>
public static void SetStaticParameter(string exchange, string key, object value)
{
if (!_staticProcessParameters.TryGetValue(exchange, out var exchangeParameters))
{
exchangeParameters = new Parameters(ParameterSerializationSettings.Default);
_staticProcessParameters[exchange] = exchangeParameters;
}
exchangeParameters.Remove(key);
exchangeParameters.AddRaw(key, value);
}
/// <summary>
/// Reset the static parameters, clears all parameters for all exchanges
/// </summary>
public static void ResetStaticParameters()
{
_staticProcessParameters.Clear();
}
/// <summary>
/// Reset the static parameters, clears all parameters for an exchange exchanges
/// </summary>
public static void ResetStaticExchangeParameters(string exchange)
{
_staticProcessParameters.Remove(exchange);
}
private static object? TryGetValue(Dictionary<string, Parameters> list, string exchange, string key)
{
if (!list.TryGetValue(exchange, out var exchangeParams))
return null;
return exchangeParams.SingleOrDefault(x => x.Key.Equals(key, StringComparison.InvariantCultureIgnoreCase)).Value;
}
}
}