mirror of
https://github.com/JKorf/CryptoExchange.Net.git
synced 2026-08-20 21:02:55 +00:00
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
This commit is contained in:
Jan Korf
@@ -1,6 +1,7 @@
|
||||
#  CryptoExchange.Net
|
||||
|
||||
[](https://github.com/JKorf/CryptoExchange.Net/actions/workflows/dotnet.yml) [](https://www.nuget.org/packages/CryptoExchange.Net) 
|
||||
|
||||
|
||||
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.
|
||||
Note that the CryptoExchange.Net package itself can not be used directly for accessing API's. Either install a client library from the list below or use [CryptoClients.Net](https://github.com/jkorf/CryptoClients.Net) which includes access to all exchange API's.
|
||||
@@ -85,6 +86,43 @@ Make a one time donation in a crypto currency of your choice. If you prefer to d
|
||||
### Sponsor
|
||||
Alternatively, sponsor me on Github using [Github Sponsors](https://github.com/sponsors/JKorf).
|
||||
|
||||
## Update notes from version 11.x to 12.x for client implementations
|
||||
* Result types:
|
||||
* (Web)CallResult types are replaced by HttpResult, WebSocketResult and QueryResult
|
||||
* Use (Http/WebSocket/Query)Result.Ok(..) and .Fail(..) for creation
|
||||
* Result objects no longer override implicit conversion to bool, use Success property instead
|
||||
* CallResult.SuccessResult has been replaced with CallResult.Ok()
|
||||
|
||||
* Parameters & serialization:
|
||||
* ParameterCollection type is replaced by Parameters, most AddXX() methods can be replaced by Add()
|
||||
* Parameter serialization behavior can be controlled in the Add method as third parameter, or in the ParameterSerializationSettings
|
||||
* ArraySerialization has been move into the new Parameters object
|
||||
* RestRequestConfiguration in AuthenticationProvider.ProcessRequest now contains the full RequestDefinition instead of copied fields. This changes for example `request.Authenticated` to `request.RequestDefinition.Authenticated`
|
||||
|
||||
WebSocket routing:
|
||||
* MessageRouting has been split into event and query routing; use CreateForEvent for subscriptions and CreateForQuery for queries.
|
||||
* Queries returning a mapped type can specify a second type parameter in CreateForQuery for the result type
|
||||
* MessageRouter.CreateWithoutHandler has been replaced with CreateVoid
|
||||
|
||||
Shared APIs:
|
||||
* Option defintions now always require the exchange name as first parameter
|
||||
* Every request/subscription now has a dedicated options type
|
||||
* ExchangeSymbolCache now requires EnvironmentName as parameter for operations
|
||||
* Validation has been unified via `SharedClient.[Request]Options.ValidateRequest(request, this);`
|
||||
* Validation now includes auth check and klines support internally, no need for explicit checks
|
||||
* AsExchangeResult/ExchangeWebResult has been removed, use normal HttpResults instead
|
||||
* ExchangeResult has been replaced by ExchangeCallResult
|
||||
* TradingMode has been removed from the response model, only maintained on models where it makes sense
|
||||
* IListenKey support has been removed, listen keys should be managed internally with TokenManager
|
||||
|
||||
Various:
|
||||
* ApiClients now require an exchange name in the constructor
|
||||
* ApiClients now required ILoggerFactory parameter instead of ILogger instance
|
||||
* RestApiClient SendAsync without type parameter removed, use SendAsync<Unit> instead
|
||||
* Address parameter removed from SendAsync RestApiClient, should be specified on the request definition instead
|
||||
* SymbolOrderBook DoResyncAsync now returns CallResult instead of CallResult<bool> which was redundant
|
||||
* PlatformInfo now required support environment names in the constructor
|
||||
|
||||
## Release notes
|
||||
* Version 11.2.2 - 08 Jun 2026
|
||||
* Fixed timing issue causing websocket connection to possible loop in error state
|
||||
|
||||
Reference in New Issue
Block a user