{"id":26358150,"url":"https://github.com/slavakuntsov/hyper-quant-api-connector","last_synced_at":"2025-10-06T19:48:31.786Z","repository":{"id":281885739,"uuid":"946738766","full_name":"SlavaKuntsov/hyper-quant-api-connector","owner":"SlavaKuntsov","description":"Test task on the topic of working with Bitfinex API at HyperQuant.","archived":false,"fork":false,"pushed_at":"2025-03-11T16:30:36.000Z","size":8,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-03-11T17:43:06.544Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"C#","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/SlavaKuntsov.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2025-03-11T15:47:33.000Z","updated_at":"2025-03-11T16:30:40.000Z","dependencies_parsed_at":"2025-03-11T17:43:37.409Z","dependency_job_id":"32ce87fd-7690-49f7-bbeb-5193e91beba6","html_url":"https://github.com/SlavaKuntsov/hyper-quant-api-connector","commit_stats":null,"previous_names":["slavakuntsov/hyper-quant-api-connector"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/SlavaKuntsov/hyper-quant-api-connector","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SlavaKuntsov%2Fhyper-quant-api-connector","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SlavaKuntsov%2Fhyper-quant-api-connector/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SlavaKuntsov%2Fhyper-quant-api-connector/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SlavaKuntsov%2Fhyper-quant-api-connector/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/SlavaKuntsov","download_url":"https://codeload.github.com/SlavaKuntsov/hyper-quant-api-connector/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SlavaKuntsov%2Fhyper-quant-api-connector/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":278671731,"owners_count":26025743,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-10-06T02:00:05.630Z","response_time":65,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2025-03-16T14:19:15.779Z","updated_at":"2025-10-06T19:48:31.780Z","avatar_url":"https://github.com/SlavaKuntsov.png","language":"C#","funding_links":[],"categories":[],"sub_categories":[],"readme":"# HyperQuant Api Connector\n### Задача\n1. Написать коннектор к API Bitfinex ([ссылка на API](https://docs.bitfinex.com/docs/introduction)) для запросов на:\n\t- Rest\n\t- WebSocket\n2. Реализовать расчет баланса портфеля на балансе которого есть некоторые валюты.\n### Реализация\nБазовый интерфейс `ITestConnector` по *Interface Segregation Principle* был разделен на `IRestApiConnector` и `IWebSocketConnector` интерфейсы.\n\nРегистрация коннекторов и конвертера в *DI*:\n``` csharp\nusing Microsoft.Extensions.DependencyInjection;\n\nservices.AddHttpClient\u003cIRestApiConnector, RestApiConnector\u003e(client =\u003e  \n{  \n    client.BaseAddress = new Uri(\"https://api-pub.bitfinex.com\");  \n});  \n  \nservices.AddHttpClient\u003cICryptocurrencyConverter, CryptocurrencyConverter\u003e(client =\u003e  \n{  \n    client.BaseAddress = new Uri(\"https://api.cryptapi.io\");  \n});  \n  \nservices.AddSingleton\u003cIWebSocketConnector\u003e(  \n    new WebSocketConnector(\"wss://api-pub.bitfinex.com/ws/2\"));\n    \n```\n\nДля конверета валют был использован сервсис [CryptAPI](https://docs.cryptapi.io/#operation/convert).\n## Models\nКроме `Candle` и `Trade` была добавлена модель `Ticker`.\nВ моделе `Trade` и `Candle` было добавлено поле `MessageType` для обозначения типа WebSocket сообщения (*\"te\" (trade executed), \"tu\" (trade updated), \"fte\" (funding trade executed), \"ftu\" (funding trade updated), \"cu\" (candle updated)*).\n## API Connectors\n### Rest\nМетоды, которые должны вернуть последовательность `IEnumerable`, возвращают значения через `yield return`, чтобы в некоторых случаях, когда возвращаются десятки тысяч обьектов, можно было избежать выделения памяти сразу под всю последовательность.\n\n**Интерфейс**\n``` csharp\npublic interface IRestApiConnector  \n{  \n    IAsyncEnumerable\u003cCandle\u003e GetCandleSeriesAsync(  \n       string pair,  \n       int periodInSec,  \n       int? sort = null,  \n       DateTimeOffset? from = null,  \n       DateTimeOffset? to = null,  \n       long? count = 0);  \n  \n    IAsyncEnumerable\u003cTrade\u003e GetNewTradesAsync(string pair, int maxCount);  \n  \n    Task\u003cTicker\u003e GetTickerAsync(string pair);  \n}\n```\n**Использование**\n``` csharp\nawait foreach (var trade in _restApiConnector.GetCandleSeriesAsync(\n\ttradingPair,  \n\tcandlePeriodInSec,  \n\tnull,  \n\tDateTimeOffset.UtcNow.AddHours(-1),  \n\tnull,  \n\tamount))\n{\n    Candles.Add(trade);\n}  \n```\n``` csharp\nawait foreach (var trade in _restApiConnector.GetNewTradesAsync(tradingPair, amount))  \n{\n    Trades.Add(trade);\n}\n```\n``` csharp\nvar ticker = await _restApiConnector.GetTickerAsync(tradingPair);\n```\n### WebSocket\nТ.к нужно реализовать только методы `SubscribeCandles` и `SubscribeTrades`, то методы по подкючению и откючению, отправке, получению и обработке сообщений должны быть реализованны уже внутри них. \n\n**Интерфейс**\n``` csharp\npublic interface IWebSocketConnector  \n{  \n    event Action\u003cCandle\u003e CandleSeriesProcessing;  \n  \n    // all parameters except Pair and Period in sec have been deleted because websocket query don't use them  \n    Task SubscribeCandles(string pair, int periodInSec);  \n    Task UnsubscribeCandles();  \n  \n    event Action\u003cTrade\u003e NewBuyTrade;  \n    event Action\u003cTrade\u003e NewSellTrade;  \n  \n    // remove the parameter maxCount since it is not used anywhere  \n    Task SubscribeTrades(string pair);  \n    Task UnsubscribeTrades();  \n}\n```\n**Использование** (Wpf)\n``` csharp\n[RelayCommand]  \nprivate async Task SubscribeCandlesAsync()  \n{  \n    CandlesWebSocket.Clear();  \n  \n    _webSocketConnector.CandleSeriesProcessing += OnWebSocketConnectorOnCandleProcessing;  \n  \n    await _webSocketConnector.SubscribeCandles(tradingPair, candlePeriodInSec);  \n}  \n  \n[RelayCommand]  \nprivate async Task UnsubscribeCandlesAsync()  \n{  \n    _webSocketConnector.CandleSeriesProcessing -= OnWebSocketConnectorOnCandleProcessing;  \n  \n    await _webSocketConnector.UnsubscribeCandles();  \n}  \n  \nprivate void OnWebSocketConnectorOnCandleProcessing(Candle candle)  \n{  \n    if (candle.MessageType == \"snapshot\")  \n       CandlesWebSocket.Add(candle);  \n    else  \n       CandlesWebSocket.Insert(0, candle);  \n}\n```\nВ функции `OnWebSocketConnectorOnCandleProcessing` есть условие для корректного вывода обьектов с сортировкой по дате (новые записи поялвяются вначале списка).\n## Converter\nДля реализации конвертера был создан класс `CryptocurrencyConverter` реализующий интерфес с методом `Convert`.\n``` csharp\npublic interface ICryptocurrencyConverter  \n{  \n    Task\u003cdecimal\u003e Convert(Cryptocurrency cryptocurrency, string to);  \n}\n```\n**Использование**\n``` csharp\nvar convertedValue = await _cryptocurrencyConverter.Convert(  \n    new Cryptocurrency(portfolio.Cryptocurrency, portfolio.Amount),  \n    portfolio.Currency);\n```\nВ параметрах принимает обьект типа `Cryptocurrency` и валюту в которую нужно перевести.\n``` csharp\npublic class Cryptocurrency  \n{  \n    public Cryptocurrency(string currency, decimal amount)  \n    {  \n       Currency = currency;  \n       Amount = amount;  \n    }  \n  \n    public string Currency { get; set; }  \n    public decimal Amount { get; set; }  \n}\n```\n#### P.S.\n`ConsoleApp` в директории `src` просьба игнорировать (исользовался при разработке).","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fslavakuntsov%2Fhyper-quant-api-connector","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fslavakuntsov%2Fhyper-quant-api-connector","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fslavakuntsov%2Fhyper-quant-api-connector/lists"}