mirror of
https://github.com/JKorf/CryptoExchange.Net.git
synced 2026-08-13 09:23:04 +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
145 lines
6.3 KiB
C#
145 lines
6.3 KiB
C#
using CryptoExchange.Net.Authentication;
|
|
using System;
|
|
|
|
namespace CryptoExchange.Net.Objects.Options
|
|
{
|
|
/// <summary>
|
|
/// Options for a rest exchange client
|
|
/// </summary>
|
|
public class RestExchangeOptions : ExchangeOptions
|
|
{
|
|
|
|
/// <summary>
|
|
/// How often the timestamp adjustment between client and server is recalculated. If you need a very small TimeSpan here you're probably better of syncing your server time more often
|
|
/// </summary>
|
|
public TimeSpan TimestampRecalculationInterval { get; set; } = TimeSpan.FromHours(1);
|
|
|
|
/// <summary>
|
|
/// Whether caching is enabled. Caching will only be applied to GET http requests. The lifetime of cached results can be determined by the `CachingMaxAge` option
|
|
/// </summary>
|
|
public bool CachingEnabled { get; set; } = false;
|
|
|
|
/// <summary>
|
|
/// The max age of a cached entry, only used when the `CachingEnabled` options is set to true. When a cached entry is older than the max age it will be discarded and a new server request will be done
|
|
/// </summary>
|
|
public TimeSpan CachingMaxAge { get; set; } = TimeSpan.FromSeconds(5);
|
|
|
|
/// <summary>
|
|
/// The HTTP protocol version to use, typically 2.0 or 1.1
|
|
/// </summary>
|
|
public Version HttpVersion { get; set; }
|
|
#if NET5_0_OR_GREATER
|
|
= new Version(2, 0);
|
|
#else
|
|
= new Version(1, 1);
|
|
#endif
|
|
|
|
/// <summary>
|
|
/// Http client keep alive interval for keeping connections open. Only applied when using dotnet8.0 or higher and dependency injection
|
|
/// </summary>
|
|
public TimeSpan? HttpKeepAliveInterval { get; set; } = TimeSpan.FromSeconds(15);
|
|
#if NET5_0_OR_GREATER
|
|
/// <summary>
|
|
/// Enable multiple simultaneous HTTP 2 connections. Only applied when using dependency injection
|
|
/// </summary>
|
|
public bool HttpEnableMultipleHttp2Connections { get; set; } = false;
|
|
/// <summary>
|
|
/// Lifetime of pooled HTTP connections; the time before a connection is recreated. Only applied when using dependency injection
|
|
/// </summary>
|
|
public TimeSpan HttpPooledConnectionLifetime { get; set; } = TimeSpan.FromMinutes(15);
|
|
/// <summary>
|
|
/// Idle timeout of pooled HTTP connections; the time before an open connection is closed when there are no requests. Only applied when using dependency injection
|
|
/// </summary>
|
|
public TimeSpan HttpPooledConnectionIdleTimeout { get; set; } = TimeSpan.FromMinutes(2);
|
|
/// <summary>
|
|
/// Max number of connections per server. Only applied when using dependency injection
|
|
/// </summary>
|
|
public int HttpMaxConnectionsPerServer { get; set; } = int.MaxValue;
|
|
#endif
|
|
|
|
/// <summary>
|
|
/// Set the values of this options on the target options
|
|
/// </summary>
|
|
public T Set<T>(T item) where T : RestExchangeOptions, new()
|
|
{
|
|
item.OutputOriginalData = OutputOriginalData;
|
|
item.AutoTimestamp = AutoTimestamp;
|
|
item.TimestampRecalculationInterval = TimestampRecalculationInterval;
|
|
item.Proxy = Proxy;
|
|
item.RequestTimeout = RequestTimeout;
|
|
item.RateLimiterEnabled = RateLimiterEnabled;
|
|
item.RateLimitingBehaviour = RateLimitingBehaviour;
|
|
item.RateLimitGroup = RateLimitGroup;
|
|
item.CachingEnabled = CachingEnabled;
|
|
item.CachingMaxAge = CachingMaxAge;
|
|
item.HttpVersion = HttpVersion;
|
|
item.HttpKeepAliveInterval = HttpKeepAliveInterval;
|
|
#if NET5_0_OR_GREATER
|
|
item.HttpMaxConnectionsPerServer = HttpMaxConnectionsPerServer;
|
|
item.HttpPooledConnectionLifetime = HttpPooledConnectionLifetime;
|
|
item.HttpPooledConnectionIdleTimeout = HttpPooledConnectionIdleTimeout;
|
|
item.HttpEnableMultipleHttp2Connections = HttpEnableMultipleHttp2Connections;
|
|
#endif
|
|
return item;
|
|
}
|
|
}
|
|
|
|
/// <inheritdoc />
|
|
public class RestExchangeOptions<TEnvironment> : RestExchangeOptions
|
|
where TEnvironment : TradeEnvironment
|
|
{
|
|
/// <summary>
|
|
/// Trade environment. Contains info about URL's to use to connect to the API. To swap environment select another environment for
|
|
/// the exchange's environment list or create a custom environment using either `[Exchange]Environment.CreateCustom()` or `[Exchange]Environment.[Environment]`, for example `KucoinEnvironment.TestNet` or `BinanceEnvironment.Live`
|
|
/// </summary>
|
|
#pragma warning disable CS8618 // Non-nullable field must contain a non-null value when exiting constructor. Consider declaring as nullable.
|
|
public TEnvironment Environment { get; set; }
|
|
#pragma warning restore CS8618 // Non-nullable field must contain a non-null value when exiting constructor. Consider declaring as nullable.
|
|
|
|
/// <summary>
|
|
/// Set the values of this options on the target options
|
|
/// </summary>
|
|
public new T Set<T>(T target) where T : RestExchangeOptions<TEnvironment>, new()
|
|
{
|
|
base.Set(target);
|
|
target.Environment = Environment;
|
|
return target;
|
|
}
|
|
|
|
/// <inheritdoc />
|
|
public override string ToString()
|
|
{
|
|
return $"{base.ToString()} | Environment: {Environment.Name}";
|
|
}
|
|
}
|
|
|
|
/// <inheritdoc />
|
|
public class RestExchangeOptions<TEnvironment, TApiCredentials> : RestExchangeOptions<TEnvironment>
|
|
where TEnvironment : TradeEnvironment
|
|
where TApiCredentials : ApiCredentials
|
|
{
|
|
|
|
/// <summary>
|
|
/// The api credentials used for signing requests to this API.
|
|
/// </summary>
|
|
public TApiCredentials? ApiCredentials { get; set; }
|
|
|
|
/// <summary>
|
|
/// Set the values of this options on the target options
|
|
/// </summary>
|
|
public new T Set<T>(T item) where T : RestExchangeOptions<TEnvironment, TApiCredentials>, new()
|
|
{
|
|
base.Set(item);
|
|
item.ApiCredentials = (TApiCredentials?)ApiCredentials?.Copy();
|
|
return item;
|
|
}
|
|
|
|
/// <inheritdoc />
|
|
public override string ToString()
|
|
{
|
|
return $"{base.ToString()} | ApiCredentials: {(ApiCredentials == null ? "-" : "set")}";
|
|
}
|
|
|
|
}
|
|
}
|