mirror of
https://github.com/JKorf/CryptoExchange.Net.git
synced 2026-08-18 20:02:57 +00:00
d079796020
Performance update: Authentication Added Ed25519 signing support for NET8.0 and newer Added static methods on ApiCredentials to create credentials of a specific type Added static ApiCredentials.ReadFromFile method to read a key from file Added required abstract SupportedCredentialTypes property on AuthenticationProvider base class General Performance Added checks before logging statements to prevent overhead of building the log string if logging is not needed Added ExchangeHelpers.ProcessQueuedAsync method to process updates async Replaced locking object types from object to Lock in NET9.0 and newer Replaced some Task response types with ValueTask to prevent allocation overhead on hot paths Updated Json ArrayConverter to reduce some allocation overhead Updated Json BoolConverter to prevent boxing Updated Json DateTimeConverter to prevent boxing Updated Json EnumConverter caching to reduce lookup overhead Updated ExtensionMethods.CreateParamString to reduce allocations Updated ExtensionMethods.AppendPath to reduce overhead REST Refactored REST message processing to separate IRestMessageHandler instance Split RestApiClient.PrepareAsync into CheckTimeSync and RateLimitAsync Updated IRequest.Accept type from string to MediaTypeWithQualityHeaderValue to prevent creation on each request Updated IRequest.GetHeaders response type from KeyValuePair<string, string[]>[] to HttpRequestHeaders to prevent additional mapping Updated IResponse.ResponseHeaders type from KeyValuePair<string, string[]>[] to HttpResponseHeaders to prevent additional mapping Updated WebCallResult RequestHeaders and ResponseHeaders types to HttpRequestHeaders and HttpResponseHeaders Removed unnecessary empty dictionary initializations for each request Removed CallResult creation in internal methods to prevent having to create multiple versions for different result types Socket Added HighPerformance websocket client implementation which significantly reduces memory overhead and improves speed but with certain limitations Added MaxIndividualSubscriptionsPerConnection setting in SocketApiClient to limit the number of individual stream subscriptions on a connection Added SocketIndividualSubscriptionCombineTarget option to set the target number of individual stream subscriptions per connection Added new websocket message handling logic which is faster and reduces memory allocation Added UseUpdatedDeserialization option to toggle between updated deserialization and old deserialization Added Exchange property to DataEvent to prevent additional mapping overhead for Shared apis Refactored message callback to be sync instead of async to prevent async overhead Refactored CryptoExchangeWebSocketClient.IncomingKbps calculation to significantly reduce overhead Moved websocket client creation from SocketApiClient to SocketConnection Removed DataEvent.As and DataEvent.ToCallResult methods in favor of single ToType method Removed DataEvent creation on lower levels to prevent having to create multiple versions for different result types Removed Subscription<TSubResponse, TUnsubResponse> as its no longer used Other Added null check to ParameterCollection for required parameters Added Net10.0 target framework Updated dependency versions Updated Shared asset aliases check to be culture invariant Updated Error string representation Updated some namespaces Updated SymbolOrderBook processing of buffered updates to prevent additional allocation Removed ExchangeEvent type which is no longer needed Removed unused usings
108 lines
4.6 KiB
C#
108 lines
4.6 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>
|
|
/// Whether or not to automatically sync the local time with the server time
|
|
/// </summary>
|
|
public bool AutoTimestamp { get; set; }
|
|
|
|
/// <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
|
|
/// </summary>
|
|
public TimeSpan? HttpKeepAliveInterval { get; set; } = TimeSpan.FromSeconds(15);
|
|
|
|
/// <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.ApiCredentials = ApiCredentials?.Copy();
|
|
item.Proxy = Proxy;
|
|
item.RequestTimeout = RequestTimeout;
|
|
item.RateLimiterEnabled = RateLimiterEnabled;
|
|
item.RateLimitingBehaviour = RateLimitingBehaviour;
|
|
item.CachingEnabled = CachingEnabled;
|
|
item.CachingMaxAge = CachingMaxAge;
|
|
item.HttpVersion = HttpVersion;
|
|
item.HttpKeepAliveInterval = HttpKeepAliveInterval;
|
|
return item;
|
|
}
|
|
}
|
|
|
|
/// <summary>
|
|
/// Options for a rest exchange client
|
|
/// </summary>
|
|
/// <typeparam name="TEnvironment"></typeparam>
|
|
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;
|
|
}
|
|
}
|
|
|
|
/// <summary>
|
|
/// Options for a rest exchange client
|
|
/// </summary>
|
|
/// <typeparam name="TEnvironment"></typeparam>
|
|
/// <typeparam name="TApiCredentials"></typeparam>
|
|
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 new TApiCredentials? ApiCredentials
|
|
{
|
|
get => (TApiCredentials?)base.ApiCredentials;
|
|
set => base.ApiCredentials = value;
|
|
}
|
|
}
|
|
}
|