mirror of
https://github.com/JKorf/CryptoExchange.Net.git
synced 2026-10-04 10:21:13 +00:00
e823114623
* 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
147 lines
4.2 KiB
C#
147 lines
4.2 KiB
C#
using System;
|
|
using System.Collections.Generic;
|
|
using System.Text;
|
|
|
|
namespace CryptoExchange.Net.Objects
|
|
{
|
|
/// <summary>
|
|
/// Settings for parameter serialization
|
|
/// </summary>
|
|
public class ParameterSerializationSettings
|
|
{
|
|
/// <summary>
|
|
/// Default serialization settings
|
|
/// </summary>
|
|
public static ParameterSerializationSettings Default { get; } = new ParameterSerializationSettings();
|
|
|
|
/// <summary>
|
|
/// Whether to sort the parameters
|
|
/// </summary>
|
|
public bool Sort { get; set; } = true;
|
|
/// <summary>
|
|
/// The parameter comparer when sorting
|
|
/// </summary>
|
|
public IComparer<string>? SortComparer { get; set; }
|
|
/// <summary>
|
|
/// Decimal serialization type
|
|
/// </summary>
|
|
public DecimalSerialization Decimal { get; set; } = DecimalSerialization.Number;
|
|
/// <summary>
|
|
/// DateTime serialization type
|
|
/// </summary>
|
|
public DateTimeSerialization DateTimes { get; set; } = DateTimeSerialization.MillisecondsNumber;
|
|
/// <summary>
|
|
/// Boolean serialization type
|
|
/// </summary>
|
|
public BoolSerialization Bool { get; set; } = BoolSerialization.Bool;
|
|
/// <summary>
|
|
/// Integer serialization type
|
|
/// </summary>
|
|
public IntegerSerialization Integer { get; set; } = IntegerSerialization.Number;
|
|
/// <summary>
|
|
/// Enum serialization type
|
|
/// </summary>
|
|
public EnumSerialization Enum { get; set; } = EnumSerialization.String;
|
|
/// <summary>
|
|
/// Array serialization type
|
|
/// </summary>
|
|
public ArrayParametersSerialization Array { get; set; } = ArrayParametersSerialization.Array;
|
|
}
|
|
|
|
|
|
/// <summary>
|
|
/// Type of decimal value serialization
|
|
/// </summary>
|
|
public enum DecimalSerialization
|
|
{
|
|
/// <summary>
|
|
/// Decimals should be serialized as numbers
|
|
/// </summary>
|
|
Number,
|
|
/// <summary>
|
|
/// Decimals should be strings
|
|
/// </summary>
|
|
String
|
|
}
|
|
|
|
/// <summary>
|
|
/// Type of DateTime value serialization
|
|
/// </summary>
|
|
public enum DateTimeSerialization
|
|
{
|
|
/// <summary>
|
|
/// DateTimes should be serialized as milliseconds number
|
|
/// </summary>
|
|
MillisecondsNumber,
|
|
/// <summary>
|
|
/// DateTimes should be serialized as milliseconds string
|
|
/// </summary>
|
|
MillisecondsString,
|
|
/// <summary>
|
|
/// DateTimes should be serialized as seconds number
|
|
/// </summary>
|
|
SecondsNumber,
|
|
/// <summary>
|
|
/// DateTimes should be serialized as seconds string
|
|
/// </summary>
|
|
SecondsString,
|
|
/// <summary>
|
|
/// DateTimes should be serialized as microseconds number
|
|
/// </summary>
|
|
MicrosecondsNumber,
|
|
/// <summary>
|
|
/// DateTimes should be serialized as microseconds string
|
|
/// </summary>
|
|
MicrosecondsString,
|
|
/// <summary>
|
|
/// DateTimes should be serialized as ISO 8601 string
|
|
/// </summary>
|
|
Rfc3339String
|
|
}
|
|
|
|
/// <summary>
|
|
/// Type of boolean value serialization
|
|
/// </summary>
|
|
public enum BoolSerialization
|
|
{
|
|
/// <summary>
|
|
/// Booleans should be serialized as bool values
|
|
/// </summary>
|
|
Bool,
|
|
/// <summary>
|
|
/// Booleans should be serialized as strings
|
|
/// </summary>
|
|
String
|
|
}
|
|
|
|
/// <summary>
|
|
/// Type of integer value serialization
|
|
/// </summary>
|
|
public enum IntegerSerialization
|
|
{
|
|
/// <summary>
|
|
/// Integers should be serialized as integer values
|
|
/// </summary>
|
|
Number,
|
|
/// <summary>
|
|
/// Integers should be serialized as strings
|
|
/// </summary>
|
|
String
|
|
}
|
|
|
|
/// <summary>
|
|
/// Type of enum value serialization
|
|
/// </summary>
|
|
public enum EnumSerialization
|
|
{
|
|
/// <summary>
|
|
/// Enums should be serialized as integer values
|
|
/// </summary>
|
|
Number,
|
|
/// <summary>
|
|
/// Enums should be serialized as strings
|
|
/// </summary>
|
|
String
|
|
}
|
|
}
|