diff --git a/.gitignore b/.gitignore index 1f6d524..86a11ab 100644 --- a/.gitignore +++ b/.gitignore @@ -287,5 +287,3 @@ __pycache__/ *.odx.cs *.xsd.cs CryptoExchange.Net/CryptoExchange.Net.xml -/Docs/* -Docs/ diff --git a/CryptoExchange.Net.UnitTests/CryptoExchange.Net.UnitTests.csproj b/CryptoExchange.Net.UnitTests/CryptoExchange.Net.UnitTests.csproj index 00248c8..e2fcd01 100644 --- a/CryptoExchange.Net.UnitTests/CryptoExchange.Net.UnitTests.csproj +++ b/CryptoExchange.Net.UnitTests/CryptoExchange.Net.UnitTests.csproj @@ -7,7 +7,7 @@ - + diff --git a/CryptoExchange.Net.UnitTests/SocketClientTests.cs b/CryptoExchange.Net.UnitTests/SocketClientTests.cs index b35dd36..0092caa 100644 --- a/CryptoExchange.Net.UnitTests/SocketClientTests.cs +++ b/CryptoExchange.Net.UnitTests/SocketClientTests.cs @@ -1,11 +1,17 @@ using System; +using System.Collections.Generic; using System.Threading; +using System.Threading.Tasks; using CryptoExchange.Net.Objects; +using CryptoExchange.Net.Objects.Sockets; using CryptoExchange.Net.Sockets; using CryptoExchange.Net.UnitTests.TestImplementations; +using CryptoExchange.Net.UnitTests.TestImplementations.Sockets; using Microsoft.Extensions.Logging; +using Moq; using Newtonsoft.Json.Linq; using NUnit.Framework; +using NUnit.Framework.Constraints; namespace CryptoExchange.Net.UnitTests { @@ -46,7 +52,7 @@ namespace CryptoExchange.Net.UnitTests } [TestCase] - public void SocketMessages_Should_BeProcessedInDataHandlers() + public async Task SocketMessages_Should_BeProcessedInDataHandlers() { // arrange var client = new TestSocketClient(options => { @@ -58,28 +64,31 @@ namespace CryptoExchange.Net.UnitTests socket.DisconnectTime = DateTime.UtcNow; var sub = new SocketConnection(new TraceLogger(), client.SubClient, socket, null); var rstEvent = new ManualResetEvent(false); - JToken result = null; - sub.AddSubscription(SocketSubscription.CreateForIdentifier(10, "TestHandler", true, false, (messageEvent) => - { - result = messageEvent.JsonData; - rstEvent.Set(); - })); + Dictionary result = null; + client.SubClient.ConnectSocketSub(sub); + sub.AddSubscription(new TestSubscription>(Mock.Of(), (messageEvent) => + { + result = messageEvent.Data; + rstEvent.Set(); + })); + // act - socket.InvokeMessage("{\"property\": 123}"); + await socket.InvokeMessage("{\"property\": \"123\", \"topic\": \"topic\"}"); rstEvent.WaitOne(1000); // assert - Assert.IsTrue((int)result["property"] == 123); + Assert.IsTrue(result["property"] == "123"); } [TestCase(false)] [TestCase(true)] - public void SocketMessages_Should_ContainOriginalDataIfEnabled(bool enabled) + public async Task SocketMessages_Should_ContainOriginalDataIfEnabled(bool enabled) { // arrange - var client = new TestSocketClient(options => { + var client = new TestSocketClient(options => + { options.ReconnectInterval = TimeSpan.Zero; options.SubOptions.OutputOriginalData = enabled; }); @@ -90,15 +99,16 @@ namespace CryptoExchange.Net.UnitTests var sub = new SocketConnection(new TraceLogger(), client.SubClient, socket, null); var rstEvent = new ManualResetEvent(false); string original = null; - sub.AddSubscription(SocketSubscription.CreateForIdentifier(10, "TestHandler", true, false, (messageEvent) => + + client.SubClient.ConnectSocketSub(sub); + sub.AddSubscription(new TestSubscription>(Mock.Of(), (messageEvent) => { original = messageEvent.OriginalData; rstEvent.Set(); })); - client.SubClient.ConnectSocketSub(sub); // act - socket.InvokeMessage("{\"property\": 123}"); + await socket.InvokeMessage("{\"property\": 123}"); rstEvent.WaitOne(1000); // assert @@ -109,16 +119,18 @@ namespace CryptoExchange.Net.UnitTests public void UnsubscribingStream_Should_CloseTheSocket() { // arrange - var client = new TestSocketClient(options => { + var client = new TestSocketClient(options => + { options.ReconnectInterval = TimeSpan.Zero; - }); + }); var socket = client.CreateSocket(); socket.CanConnect = true; var sub = new SocketConnection(new TraceLogger(), client.SubClient, socket, null); client.SubClient.ConnectSocketSub(sub); - var us = SocketSubscription.CreateForIdentifier(10, "Test", true, false, (e) => { }); - var ups = new UpdateSubscription(sub, us); - sub.AddSubscription(us); + + var subscription = new TestSubscription>(Mock.Of(), (messageEvent) => { }); + var ups = new UpdateSubscription(sub, subscription); + sub.AddSubscription(subscription); // act client.UnsubscribeAsync(ups).Wait(); @@ -140,12 +152,13 @@ namespace CryptoExchange.Net.UnitTests var sub2 = new SocketConnection(new TraceLogger(), client.SubClient, socket2, null); client.SubClient.ConnectSocketSub(sub1); client.SubClient.ConnectSocketSub(sub2); - var us1 = SocketSubscription.CreateForIdentifier(10, "Test1", true, false, (e) => { }); - var us2 = SocketSubscription.CreateForIdentifier(11, "Test2", true, false, (e) => { }); - sub1.AddSubscription(us1); - sub2.AddSubscription(us2); - var ups1 = new UpdateSubscription(sub1, us1); - var ups2 = new UpdateSubscription(sub2, us2); + var subscription1 = new TestSubscription>(Mock.Of(), (messageEvent) => { }); + var subscription2 = new TestSubscription>(Mock.Of(), (messageEvent) => { }); + + sub1.AddSubscription(subscription1); + sub2.AddSubscription(subscription2); + var ups1 = new UpdateSubscription(sub1, subscription1); + var ups2 = new UpdateSubscription(sub2, subscription2); // act client.UnsubscribeAllAsync().Wait(); diff --git a/CryptoExchange.Net.UnitTests/SymbolOrderBookTests.cs b/CryptoExchange.Net.UnitTests/SymbolOrderBookTests.cs index 825e435..e349d72 100644 --- a/CryptoExchange.Net.UnitTests/SymbolOrderBookTests.cs +++ b/CryptoExchange.Net.UnitTests/SymbolOrderBookTests.cs @@ -5,8 +5,8 @@ using System.Threading.Tasks; using CryptoExchange.Net.Interfaces; using CryptoExchange.Net.Objects; using CryptoExchange.Net.Objects.Options; +using CryptoExchange.Net.Objects.Sockets; using CryptoExchange.Net.OrderBook; -using CryptoExchange.Net.Sockets; using NUnit.Framework; namespace CryptoExchange.Net.UnitTests @@ -14,13 +14,13 @@ namespace CryptoExchange.Net.UnitTests [TestFixture] public class SymbolOrderBookTests { - private static OrderBookOptions defaultOrderBookOptions = new OrderBookOptions(); + private static readonly OrderBookOptions _defaultOrderBookOptions = new OrderBookOptions(); private class TestableSymbolOrderBook : SymbolOrderBook { public TestableSymbolOrderBook() : base(null, "Test", "BTC/USD") { - Initialize(defaultOrderBookOptions); + Initialize(_defaultOrderBookOptions); } diff --git a/CryptoExchange.Net.UnitTests/TestImplementations/Sockets/TestQuery.cs b/CryptoExchange.Net.UnitTests/TestImplementations/Sockets/TestQuery.cs new file mode 100644 index 0000000..4eafbd8 --- /dev/null +++ b/CryptoExchange.Net.UnitTests/TestImplementations/Sockets/TestQuery.cs @@ -0,0 +1,19 @@ +using CryptoExchange.Net.Sockets; +using System; +using System.Collections.Generic; +using System.Linq; +using System.Text; +using System.Threading.Tasks; + +namespace CryptoExchange.Net.UnitTests.TestImplementations.Sockets +{ + internal class TestQuery : Query + { + public override HashSet ListenerIdentifiers { get; set; } + + public TestQuery(string identifier, object request, bool authenticated, int weight = 1) : base(request, authenticated, weight) + { + ListenerIdentifiers = new HashSet { identifier }; + } + } +} diff --git a/CryptoExchange.Net.UnitTests/TestImplementations/Sockets/TestSubscription.cs b/CryptoExchange.Net.UnitTests/TestImplementations/Sockets/TestSubscription.cs new file mode 100644 index 0000000..84747cf --- /dev/null +++ b/CryptoExchange.Net.UnitTests/TestImplementations/Sockets/TestSubscription.cs @@ -0,0 +1,36 @@ +using CryptoExchange.Net.Objects; +using CryptoExchange.Net.Objects.Sockets; +using CryptoExchange.Net.Sockets; +using CryptoExchange.Net.Sockets.MessageParsing.Interfaces; +using Microsoft.Extensions.Logging; +using System; +using System.Collections.Generic; +using System.Linq; +using System.Text; +using System.Threading.Tasks; + +namespace CryptoExchange.Net.UnitTests.TestImplementations.Sockets +{ + internal class TestSubscription : Subscription + { + private readonly Action> _handler; + + public override HashSet ListenerIdentifiers { get; set; } = new HashSet { "topic" }; + + public TestSubscription(ILogger logger, Action> handler) : base(logger, false) + { + _handler = handler; + } + + public override Task DoHandleMessageAsync(SocketConnection connection, DataEvent message) + { + var data = (T)message.Data; + _handler.Invoke(message.As(data)); + return Task.FromResult(new CallResult(null)); + } + + public override Type GetMessageType(IMessageAccessor message) => typeof(T); + public override Query GetSubQuery(SocketConnection connection) => new TestQuery("sub", new object(), false, 1); + public override Query GetUnsubQuery() => new TestQuery("unsub", new object(), false, 1); + } +} diff --git a/CryptoExchange.Net.UnitTests/TestImplementations/TestSocket.cs b/CryptoExchange.Net.UnitTests/TestImplementations/TestSocket.cs index 7f2afb1..82f1812 100644 --- a/CryptoExchange.Net.UnitTests/TestImplementations/TestSocket.cs +++ b/CryptoExchange.Net.UnitTests/TestImplementations/TestSocket.cs @@ -1,4 +1,6 @@ using System; +using System.IO; +using System.Net.WebSockets; using System.Security.Authentication; using System.Text; using System.Threading.Tasks; @@ -12,16 +14,15 @@ namespace CryptoExchange.Net.UnitTests.TestImplementations public bool CanConnect { get; set; } public bool Connected { get; set; } - public event Action OnClose; - + public event Func OnClose; #pragma warning disable 0067 - public event Action OnReconnected; - public event Action OnReconnecting; + public event Func OnReconnected; + public event Func OnReconnecting; #pragma warning restore 0067 - public event Action OnRequestSent; - public event Action OnMessage; - public event Action OnError; - public event Action OnOpen; + public event Func OnRequestSent; + public event Func OnStreamMessage; + public event Func OnError; + public event Func OnOpen; public Func> GetReconnectionUrl { get; set; } public int Id { get; } @@ -110,9 +111,10 @@ namespace CryptoExchange.Net.UnitTests.TestImplementations OnOpen?.Invoke(); } - public void InvokeMessage(string data) + public async Task InvokeMessage(string data) { - OnMessage?.Invoke(data); + var stream = new MemoryStream(Encoding.UTF8.GetBytes(data)); + await OnStreamMessage?.Invoke(WebSocketMessageType.Text, stream); } public void SetProxy(ApiProxy proxy) diff --git a/CryptoExchange.Net.UnitTests/TestImplementations/TestSocketClient.cs b/CryptoExchange.Net.UnitTests/TestImplementations/TestSocketClient.cs index 54b551c..eb9a358 100644 --- a/CryptoExchange.Net.UnitTests/TestImplementations/TestSocketClient.cs +++ b/CryptoExchange.Net.UnitTests/TestImplementations/TestSocketClient.cs @@ -5,7 +5,9 @@ using CryptoExchange.Net.Authentication; using CryptoExchange.Net.Interfaces; using CryptoExchange.Net.Objects; using CryptoExchange.Net.Objects.Options; +using CryptoExchange.Net.Objects.Sockets; using CryptoExchange.Net.Sockets; +using CryptoExchange.Net.Sockets.MessageParsing.Interfaces; using Microsoft.Extensions.Logging; using Moq; using Newtonsoft.Json.Linq; @@ -88,35 +90,6 @@ namespace CryptoExchange.Net.UnitTests.TestImplementations return ConnectSocketAsync(sub).Result; } - protected internal override bool HandleQueryResponse(SocketConnection s, object request, JToken data, out CallResult callResult) - { - throw new NotImplementedException(); - } - - protected internal override bool HandleSubscriptionResponse(SocketConnection s, SocketSubscription subscription, object request, JToken message, - out CallResult callResult) - { - throw new NotImplementedException(); - } - - protected internal override bool MessageMatchesHandler(SocketConnection s, JToken message, object request) - { - throw new NotImplementedException(); - } - - protected internal override bool MessageMatchesHandler(SocketConnection s, JToken message, string identifier) - { - return true; - } - - protected internal override Task> AuthenticateSocketAsync(SocketConnection s) - { - throw new NotImplementedException(); - } - - protected internal override Task UnsubscribeAsync(SocketConnection connection, SocketSubscription s) - { - throw new NotImplementedException(); - } + public override string GetListenerIdentifier(IMessageAccessor messageAccessor) => "topic"; } } diff --git a/CryptoExchange.Net/Clients/BaseApiClient.cs b/CryptoExchange.Net/Clients/BaseApiClient.cs index 55072c7..2b0846e 100644 --- a/CryptoExchange.Net/Clients/BaseApiClient.cs +++ b/CryptoExchange.Net/Clients/BaseApiClient.cs @@ -1,8 +1,6 @@ using System; using System.Collections.Generic; -using System.Globalization; using System.IO; -using System.Net; using System.Net.Http; using System.Text; using System.Threading.Tasks; @@ -251,7 +249,6 @@ namespace CryptoExchange.Net if (OutputOriginalData == true) { data = await reader.ReadToEndAsync().ConfigureAwait(false); - _logger.Log(LogLevel.Debug, $"{(requestId != null ? $"[{requestId}] " : "")}Response received{(elapsedMilliseconds != null ? $" in {elapsedMilliseconds}" : " ")}ms: " + data); var result = Deserialize(data, serializer, requestId); result.OriginalData = data; return result; @@ -260,7 +257,6 @@ namespace CryptoExchange.Net // If we don't have to keep track of the original json data we can use the JsonTextReader to deserialize the stream directly // into the desired object, which has increased performance over first reading the string value into memory and deserializing from that using var jsonReader = new JsonTextReader(reader); - _logger.Log(LogLevel.Debug, $"{(requestId != null ? $"[{requestId}] " : "")}Response received{(elapsedMilliseconds != null ? $" in {elapsedMilliseconds}" : " ")}ms"); return new CallResult(serializer.Deserialize(jsonReader)!); } catch (JsonReaderException jre) diff --git a/CryptoExchange.Net/Clients/BaseClient.cs b/CryptoExchange.Net/Clients/BaseClient.cs index 2a7a589..6a2c280 100644 --- a/CryptoExchange.Net/Clients/BaseClient.cs +++ b/CryptoExchange.Net/Clients/BaseClient.cs @@ -1,5 +1,4 @@ using CryptoExchange.Net.Authentication; -using CryptoExchange.Net.Objects; using CryptoExchange.Net.Objects.Options; using Microsoft.Extensions.Logging; using Microsoft.Extensions.Logging.Abstractions; diff --git a/CryptoExchange.Net/Clients/BaseSocketClient.cs b/CryptoExchange.Net/Clients/BaseSocketClient.cs index a9c82bf..e817282 100644 --- a/CryptoExchange.Net/Clients/BaseSocketClient.cs +++ b/CryptoExchange.Net/Clients/BaseSocketClient.cs @@ -4,7 +4,7 @@ using System.Linq; using System.Text; using System.Threading.Tasks; using CryptoExchange.Net.Interfaces; -using CryptoExchange.Net.Sockets; +using CryptoExchange.Net.Objects.Sockets; using Microsoft.Extensions.Logging; namespace CryptoExchange.Net @@ -101,8 +101,10 @@ namespace CryptoExchange.Net public string GetSubscriptionsState() { var result = new StringBuilder(); - foreach(var client in ApiClients.OfType()) - result.AppendLine(client.GetSubscriptionsState()); + foreach (var client in ApiClients.OfType().Where(c => c.CurrentSubscriptions > 0)) + { + result.AppendLine(client.GetSubscriptionsState()); + } return result.ToString(); } } diff --git a/CryptoExchange.Net/Clients/CryptoBaseClient.cs b/CryptoExchange.Net/Clients/CryptoBaseClient.cs new file mode 100644 index 0000000..e577721 --- /dev/null +++ b/CryptoExchange.Net/Clients/CryptoBaseClient.cs @@ -0,0 +1,67 @@ +using Microsoft.Extensions.DependencyInjection; +using System; +using System.Collections.Generic; + +namespace CryptoExchange.Net.Clients +{ + /// + /// Base crypto client + /// + public class CryptoBaseClient : IDisposable + { + private Dictionary _serviceCache = new Dictionary(); + + /// + /// Service provider + /// + protected readonly IServiceProvider? _serviceProvider; + + /// + /// ctor + /// + public CryptoBaseClient() { } + + /// + /// ctor + /// + /// + public CryptoBaseClient(IServiceProvider serviceProvider) + { + _serviceProvider = serviceProvider; + _serviceCache = new Dictionary(); + } + + /// + /// Try get a client by type for the service collection + /// + /// + /// + public T TryGet(Func createFunc) + { + var type = typeof(T); + if (_serviceCache.TryGetValue(type, out var value)) + return (T)value; + + if (_serviceProvider == null) + { + // Create with default options + var createResult = createFunc(); + _serviceCache.Add(typeof(T), createResult!); + return createResult; + } + + var result = _serviceProvider.GetService() + ?? throw new InvalidOperationException($"No service was found for {typeof(T).Name}, make sure the exchange is registered in dependency injection with the `services.Add[Exchange]()` method"); + _serviceCache.Add(type, result!); + return result; + } + + /// + /// Dispose + /// + public void Dispose() + { + _serviceCache.Clear(); + } + } +} diff --git a/CryptoExchange.Net/Clients/CryptoRestClient.cs b/CryptoExchange.Net/Clients/CryptoRestClient.cs new file mode 100644 index 0000000..e5bc182 --- /dev/null +++ b/CryptoExchange.Net/Clients/CryptoRestClient.cs @@ -0,0 +1,47 @@ +using CryptoExchange.Net.Interfaces; +using CryptoExchange.Net.Interfaces.CommonClients; +using Microsoft.Extensions.DependencyInjection; +using System; +using System.Collections.Generic; +using System.Linq; + +namespace CryptoExchange.Net.Clients +{ + /// + public class CryptoRestClient : CryptoBaseClient, ICryptoRestClient + { + /// + /// ctor + /// + public CryptoRestClient() + { + } + + /// + /// ctor + /// + /// + public CryptoRestClient(IServiceProvider serviceProvider) : base(serviceProvider) + { + } + + /// + /// Get a list of the registered ISpotClient implementations + /// + /// + public IEnumerable GetSpotClients() + { + if (_serviceProvider == null) + return new List(); + + return _serviceProvider.GetServices().ToList(); + } + + /// + /// Get an ISpotClient implementation by exchange name + /// + /// + /// + public ISpotClient? SpotClient(string exchangeName) => _serviceProvider.GetServices()?.SingleOrDefault(s => s.ExchangeName.Equals(exchangeName, StringComparison.InvariantCultureIgnoreCase)); + } +} diff --git a/CryptoExchange.Net/Clients/CryptoSocketClient.cs b/CryptoExchange.Net/Clients/CryptoSocketClient.cs new file mode 100644 index 0000000..5c33ef9 --- /dev/null +++ b/CryptoExchange.Net/Clients/CryptoSocketClient.cs @@ -0,0 +1,24 @@ +using CryptoExchange.Net.Interfaces; +using System; + +namespace CryptoExchange.Net.Clients +{ + /// + public class CryptoSocketClient : CryptoBaseClient, ICryptoSocketClient + { + /// + /// ctor + /// + public CryptoSocketClient() + { + } + + /// + /// ctor + /// + /// + public CryptoSocketClient(IServiceProvider serviceProvider) : base(serviceProvider) + { + } + } +} diff --git a/CryptoExchange.Net/Clients/RestApiClient.cs b/CryptoExchange.Net/Clients/RestApiClient.cs index 266a013..bf80113 100644 --- a/CryptoExchange.Net/Clients/RestApiClient.cs +++ b/CryptoExchange.Net/Clients/RestApiClient.cs @@ -116,9 +116,9 @@ namespace CryptoExchange.Net var result = await GetResponseAsync(request.Data, deserializer, cancellationToken, true).ConfigureAwait(false); if (!result) - _logger.Log(LogLevel.Warning, $"[{result.RequestId}] Error received in {result.ResponseTime!.Value.TotalMilliseconds}ms: {result.Error}"); + _logger.Log(LogLevel.Warning, $"[Req {result.RequestId}] {result.ResponseStatusCode} Error received in {result.ResponseTime!.Value.TotalMilliseconds}ms: {result.Error}"); else - _logger.Log(LogLevel.Debug, $"[{result.RequestId}] Response received in {result.ResponseTime!.Value.TotalMilliseconds}ms{(OutputOriginalData ? (": " + result.OriginalData) : "")}"); + _logger.Log(LogLevel.Debug, $"[Req {result.RequestId}] {result.ResponseStatusCode} Response received in {result.ResponseTime!.Value.TotalMilliseconds}ms{(OutputOriginalData ? (": " + result.OriginalData) : "")}"); if (await ShouldRetryRequestAsync(result, currentTry).ConfigureAwait(false)) continue; @@ -170,9 +170,9 @@ namespace CryptoExchange.Net var result = await GetResponseAsync(request.Data, deserializer, cancellationToken, false).ConfigureAwait(false); if (!result) - _logger.Log(LogLevel.Warning, $"[{result.RequestId}] Error received in {result.ResponseTime!.Value.TotalMilliseconds}ms: {result.Error}"); + _logger.Log(LogLevel.Warning, $"[Req {result.RequestId}] {result.ResponseStatusCode} Error received in {result.ResponseTime!.Value.TotalMilliseconds}ms: {result.Error}"); else - _logger.Log(LogLevel.Debug, $"[{result.RequestId}] Response received in {result.ResponseTime!.Value.TotalMilliseconds}ms{(OutputOriginalData ? (": " + result.OriginalData) : "")}"); + _logger.Log(LogLevel.Debug, $"[Req {result.RequestId}] {result.ResponseStatusCode} Response received in {result.ResponseTime!.Value.TotalMilliseconds}ms{(OutputOriginalData ? (": " + result.OriginalData) : "")}"); if (await ShouldRetryRequestAsync(result, currentTry).ConfigureAwait(false)) continue; @@ -224,7 +224,7 @@ namespace CryptoExchange.Net var syncTimeResult = await syncTask.ConfigureAwait(false); if (!syncTimeResult) { - _logger.Log(LogLevel.Debug, $"[{requestId}] Failed to sync time, aborting request: " + syncTimeResult.Error); + _logger.Log(LogLevel.Debug, $"[Req {requestId}] Failed to sync time, aborting request: " + syncTimeResult.Error); return syncTimeResult.As(default); } } @@ -242,11 +242,11 @@ namespace CryptoExchange.Net if (signed && AuthenticationProvider == null) { - _logger.Log(LogLevel.Warning, $"[{requestId}] Request {uri.AbsolutePath} failed because no ApiCredentials were provided"); + _logger.Log(LogLevel.Warning, $"[Req {requestId}] Request {uri.AbsolutePath} failed because no ApiCredentials were provided"); return new CallResult(new NoApiCredentialsError()); } - _logger.Log(LogLevel.Information, $"[{requestId}] Creating request for " + uri); + _logger.Log(LogLevel.Information, $"[Req {requestId}] Creating request for " + uri); var paramsPosition = parameterPosition ?? ParameterPositions[method]; var request = ConstructRequest(uri, method, parameters?.OrderBy(p => p.Key).ToDictionary(p => p.Key, p => p.Value), signed, paramsPosition, arraySerialization ?? this.arraySerialization, requestBodyFormat ?? this.requestBodyFormat, requestId, additionalHeaders); @@ -259,7 +259,7 @@ namespace CryptoExchange.Net paramString += " with headers " + string.Join(", ", headers.Select(h => h.Key + $"=[{string.Join(",", h.Value)}]")); TotalRequestsMade++; - _logger.Log(LogLevel.Trace, $"[{requestId}] Sending {method}{(signed ? " signed" : "")} request to {request.Uri}{paramString ?? " "}"); + _logger.Log(LogLevel.Trace, $"[Req {requestId}] Sending {method}{(signed ? " signed" : "")} request to {request.Uri}{paramString ?? " "}"); return new CallResult(request); } diff --git a/CryptoExchange.Net/Clients/SocketApiClient.cs b/CryptoExchange.Net/Clients/SocketApiClient.cs index db94163..982fcdf 100644 --- a/CryptoExchange.Net/Clients/SocketApiClient.cs +++ b/CryptoExchange.Net/Clients/SocketApiClient.cs @@ -1,18 +1,21 @@ using CryptoExchange.Net.Interfaces; using CryptoExchange.Net.Objects; using CryptoExchange.Net.Objects.Options; +using CryptoExchange.Net.Objects.Sockets; using CryptoExchange.Net.Sockets; +using CryptoExchange.Net.Sockets.MessageParsing.Interfaces; using Microsoft.Extensions.Logging; -using Newtonsoft.Json.Linq; using System; using System.Collections.Concurrent; using System.Collections.Generic; -using System.Diagnostics.CodeAnalysis; +using System.Diagnostics; +using System.IO; using System.Linq; +using System.Net.Sockets; +using System.Net.WebSockets; using System.Text; using System.Threading; using System.Threading.Tasks; -using static CryptoExchange.Net.Objects.RateLimiter; namespace CryptoExchange.Net { @@ -40,47 +43,31 @@ namespace CryptoExchange.Net /// protected TimeSpan KeepAliveInterval { get; set; } = TimeSpan.FromSeconds(10); - /// - /// Delegate used for processing byte data received from socket connections before it is processed by handlers - /// - protected Func? dataInterpreterBytes; - - /// - /// Delegate used for processing string data received from socket connections before it is processed by handlers - /// - protected Func? dataInterpreterString; - /// /// Handlers for data from the socket which doesn't need to be forwarded to the caller. Ping or welcome messages for example. /// - protected Dictionary> genericHandlers = new(); - - /// - /// The task that is sending periodic data on the websocket. Can be used for sending Ping messages every x seconds or similair. Not necesarry. - /// - protected Task? periodicTask; - - /// - /// Wait event for the periodicTask - /// - protected AsyncResetEvent? periodicEvent; - - /// - /// If true; data which is a response to a query will also be distributed to subscriptions - /// If false; data which is a response to a query won't get forwarded to subscriptions as well - /// - protected internal bool ContinueOnQueryResponse { get; protected set; } + protected List systemSubscriptions = new(); /// /// If a message is received on the socket which is not handled by a handler this boolean determines whether this logs an error message /// protected internal bool UnhandledMessageExpected { get; set; } + /// + /// If true a subscription will accept message before the confirmation of a subscription has been received + /// + protected bool HandleMessageBeforeConfirmation { get; set; } + /// /// The rate limiters /// protected internal IEnumerable? RateLimiters { get; set; } + /// + /// Periodic task regisrations + /// + protected List PeriodicTaskRegistrations { get; set; } = new List(); + /// public double IncomingKbps { @@ -104,16 +91,16 @@ namespace CryptoExchange.Net if (!socketConnections.Any()) return 0; - return socketConnections.Sum(s => s.Value.SubscriptionCount); + return socketConnections.Sum(s => s.Value.UserSubscriptionCount); } } - /// public new SocketExchangeOptions ClientOptions => (SocketExchangeOptions)base.ClientOptions; /// public new SocketApiOptions ApiOptions => (SocketApiOptions)base.ApiOptions; + #endregion /// @@ -138,49 +125,50 @@ namespace CryptoExchange.Net } /// - /// Set a delegate to be used for processing data received from socket connections before it is processed by handlers + /// Add a query to periodically send on each connection /// - /// Handler for byte data - /// Handler for string data - protected void SetDataInterpreter(Func? byteHandler, Func? stringHandler) + /// + /// + /// + /// + protected virtual void RegisterPeriodicQuery(string identifier, TimeSpan interval, Func queryDelegate, Action? callback) { - dataInterpreterBytes = byteHandler; - dataInterpreterString = stringHandler; + PeriodicTaskRegistrations.Add(new PeriodicTaskRegistration + { + Identifier = identifier, + Callback = callback, + Interval = interval, + QueryDelegate = queryDelegate + }); } /// /// Connect to an url and listen for data on the BaseAddress /// - /// The type of the expected data - /// The optional request object to send, will be serialized to json - /// The identifier to use, necessary if no request object is sent - /// If the subscription is to an authenticated endpoint - /// The handler of update data + /// The subscription /// Cancellation token for closing this subscription /// - protected virtual Task> SubscribeAsync(object? request, string? identifier, bool authenticated, Action> dataHandler, CancellationToken ct) + protected virtual Task> SubscribeAsync(Subscription subscription, CancellationToken ct) { - return SubscribeAsync(BaseAddress, request, identifier, authenticated, dataHandler, ct); + return SubscribeAsync(BaseAddress, subscription, ct); } /// /// Connect to an url and listen for data /// - /// The type of the expected data /// The URL to connect to - /// The optional request object to send, will be serialized to json - /// The identifier to use, necessary if no request object is sent - /// If the subscription is to an authenticated endpoint - /// The handler of update data + /// The subscription /// Cancellation token for closing this subscription /// - protected virtual async Task> SubscribeAsync(string url, object? request, string? identifier, bool authenticated, Action> dataHandler, CancellationToken ct) + protected virtual async Task> SubscribeAsync(string url, Subscription subscription, CancellationToken ct) { if (_disposing) return new CallResult(new InvalidOperationError("Client disposed, can't subscribe")); + if (subscription.Authenticated && AuthenticationProvider == null) + return new CallResult(new NoApiCredentialsError()); + SocketConnection socketConnection; - SocketSubscription? subscription; var released = false; // Wait for a semaphore here, so we only connect 1 socket at a time. // This is necessary for being able to see if connections can be combined @@ -198,17 +186,17 @@ namespace CryptoExchange.Net while (true) { // Get a new or existing socket connection - var socketResult = await GetSocketConnection(url, authenticated).ConfigureAwait(false); + var socketResult = await GetSocketConnection(url, subscription.Authenticated).ConfigureAwait(false); if (!socketResult) return socketResult.As(null); socketConnection = socketResult.Data; // Add a subscription on the socket connection - subscription = AddSubscription(request, identifier, true, socketConnection, dataHandler, authenticated); - if (subscription == null) + var success = socketConnection.CanAddSubscription(); + if (!success) { - _logger.Log(LogLevel.Trace, $"Socket {socketConnection.SocketId} failed to add subscription, retrying on different connection"); + _logger.Log(LogLevel.Trace, $"[Sckt {socketConnection.SocketId}] failed to add subscription, retrying on different connection"); continue; } @@ -221,7 +209,7 @@ namespace CryptoExchange.Net var needsConnecting = !socketConnection.Connected; - var connectResult = await ConnectIfNeededAsync(socketConnection, authenticated).ConfigureAwait(false); + var connectResult = await ConnectIfNeededAsync(socketConnection, subscription.Authenticated).ConfigureAwait(false); if (!connectResult) return new CallResult(connectResult.Error!); @@ -236,75 +224,60 @@ namespace CryptoExchange.Net if (socketConnection.PausedActivity) { - _logger.Log(LogLevel.Warning, $"Socket {socketConnection.SocketId} has been paused, can't subscribe at this moment"); + _logger.Log(LogLevel.Warning, $"[Sckt {socketConnection.SocketId}] has been paused, can't subscribe at this moment"); return new CallResult(new ServerError("Socket is paused")); } - if (request != null) + var waitEvent = new AsyncResetEvent(false); + var subQuery = subscription.GetSubQuery(socketConnection); + if (subQuery != null) { + if (HandleMessageBeforeConfirmation) + socketConnection.AddSubscription(subscription); + // Send the request and wait for answer - var subResult = await SubscribeAndWaitAsync(socketConnection, request, subscription).ConfigureAwait(false); + var subResult = await socketConnection.SendAndWaitQueryAsync(subQuery, waitEvent).ConfigureAwait(false); if (!subResult) { - _logger.Log(LogLevel.Warning, $"Socket {socketConnection.SocketId} failed to subscribe: {subResult.Error}"); - await socketConnection.CloseAsync(subscription).ConfigureAwait(false); + waitEvent?.Set(); + _logger.Log(LogLevel.Warning, $"[Sckt {socketConnection.SocketId}] failed to subscribe: {subResult.Error}"); + // If this was a timeout we still need to send an unsubscribe to prevent messages coming in later + var unsubscribe = subResult.Error is CancellationRequestedError; + await socketConnection.CloseAsync(subscription, unsubscribe).ConfigureAwait(false); + return new CallResult(subResult.Error!); } - } - else - { - // No request to be sent, so just mark the subscription as comfirmed - subscription.Confirmed = true; + + subscription.HandleSubQueryResponse(subQuery.Response!); } + subscription.Confirmed = true; if (ct != default) { subscription.CancellationTokenRegistration = ct.Register(async () => { - _logger.Log(LogLevel.Information, $"Socket {socketConnection.SocketId} Cancellation token set, closing subscription"); + _logger.Log(LogLevel.Information, $"[Sckt {socketConnection.SocketId}] Cancellation token set, closing subscription {subscription.Id}"); await socketConnection.CloseAsync(subscription).ConfigureAwait(false); }, false); } - _logger.Log(LogLevel.Information, $"Socket {socketConnection.SocketId} subscription {subscription.Id} completed successfully"); + if (!HandleMessageBeforeConfirmation) + socketConnection.AddSubscription(subscription); + + waitEvent?.Set(); + _logger.Log(LogLevel.Information, $"[Sckt {socketConnection.SocketId}] subscription {subscription.Id} completed successfully"); return new CallResult(new UpdateSubscription(socketConnection, subscription)); } - /// - /// Sends the subscribe request and waits for a response to that request - /// - /// The connection to send the request on - /// The request to send, will be serialized to json - /// The subscription the request is for - /// - protected internal virtual async Task> SubscribeAndWaitAsync(SocketConnection socketConnection, object request, SocketSubscription subscription) - { - CallResult? callResult = null; - await socketConnection.SendAndWaitAsync(request, ClientOptions.RequestTimeout, subscription, 1, data => HandleSubscriptionResponse(socketConnection, subscription, request, data, out callResult)).ConfigureAwait(false); - - if (callResult?.Success == true) - { - subscription.Confirmed = true; - return new CallResult(true); - } - - if (callResult == null) - return new CallResult(new ServerError("No response on subscription request received")); - - return new CallResult(callResult.Error!); - } - /// /// Send a query on a socket connection to the BaseAddress and wait for the response /// /// Expected result type - /// The request to send, will be serialized to json - /// If the query is to an authenticated endpoint - /// Weight of the request + /// The query /// - protected virtual Task> QueryAsync(object request, bool authenticated, int weight = 1) + protected virtual Task> QueryAsync(Query query) { - return QueryAsync(BaseAddress, request, authenticated, weight); + return QueryAsync(BaseAddress, query); } /// @@ -312,11 +285,9 @@ namespace CryptoExchange.Net /// /// The expected result type /// The url for the request - /// The request to send - /// Whether the socket should be authenticated - /// Weight of the request + /// The query /// - protected virtual async Task> QueryAsync(string url, object request, bool authenticated, int weight = 1) + protected virtual async Task> QueryAsync(string url, Query query) { if (_disposing) return new CallResult(new InvalidOperationError("Client disposed, can't query")); @@ -326,7 +297,7 @@ namespace CryptoExchange.Net await semaphoreSlim.WaitAsync().ConfigureAwait(false); try { - var socketResult = await GetSocketConnection(url, authenticated).ConfigureAwait(false); + var socketResult = await GetSocketConnection(url, query.Authenticated).ConfigureAwait(false); if (!socketResult) return socketResult.As(default); @@ -339,7 +310,7 @@ namespace CryptoExchange.Net released = true; } - var connectResult = await ConnectIfNeededAsync(socketConnection, authenticated).ConfigureAwait(false); + var connectResult = await ConnectIfNeededAsync(socketConnection, query.Authenticated).ConfigureAwait(false); if (!connectResult) return new CallResult(connectResult.Error!); } @@ -351,34 +322,11 @@ namespace CryptoExchange.Net if (socketConnection.PausedActivity) { - _logger.Log(LogLevel.Warning, $"Socket {socketConnection.SocketId} has been paused, can't send query at this moment"); + _logger.Log(LogLevel.Warning, $"[Sckt {socketConnection.SocketId}] has been paused, can't send query at this moment"); return new CallResult(new ServerError("Socket is paused")); } - return await QueryAndWaitAsync(socketConnection, request, weight).ConfigureAwait(false); - } - - /// - /// Sends the query request and waits for the result - /// - /// The expected result type - /// The connection to send and wait on - /// The request to send - /// The weight of the query - /// - protected virtual async Task> QueryAndWaitAsync(SocketConnection socket, object request, int weight) - { - var dataResult = new CallResult(new ServerError("No response on query received")); - await socket.SendAndWaitAsync(request, ClientOptions.RequestTimeout, null, weight, data => - { - if (!HandleQueryResponse(socket, request, data, out var callResult)) - return false; - - dataResult = callResult; - return true; - }).ConfigureAwait(false); - - return dataResult; + return await socketConnection.SendAndWaitQueryAsync(query).ConfigureAwait(false); } /// @@ -402,149 +350,56 @@ namespace CryptoExchange.Net if (!authenticated || socket.Authenticated) return new CallResult(true); - _logger.Log(LogLevel.Debug, $"Socket {socket.SocketId} Attempting to authenticate"); - var result = await AuthenticateSocketAsync(socket).ConfigureAwait(false); - if (!result) - { - _logger.Log(LogLevel.Warning, $"Socket {socket.SocketId} authentication failed"); - if (socket.Connected) - await socket.CloseAsync().ConfigureAwait(false); + return await AuthenticateSocketAsync(socket).ConfigureAwait(false); + } - result.Error!.Message = "Authentication failed: " + result.Error.Message; - return new CallResult(result.Error); + /// + /// Authenticate a socket connection + /// + /// Socket to authenticate + /// + public virtual async Task> AuthenticateSocketAsync(SocketConnection socket) + { + if (AuthenticationProvider == null) + return new CallResult(new NoApiCredentialsError()); + + _logger.Log(LogLevel.Debug, $"[Sckt {socket.SocketId}] Attempting to authenticate"); + var authRequest = GetAuthenticationRequest(); + if (authRequest != null) + { + var result = await socket.SendAndWaitQueryAsync(authRequest).ConfigureAwait(false); + + if (!result) + { + _logger.Log(LogLevel.Warning, $"[Sckt {socket.SocketId}] authentication failed"); + if (socket.Connected) + await socket.CloseAsync().ConfigureAwait(false); + + result.Error!.Message = "Authentication failed: " + result.Error.Message; + return new CallResult(result.Error)!; + } } - _logger.Log(LogLevel.Debug, $"Socket {socket.SocketId} authenticated"); + _logger.Log(LogLevel.Debug, $"[Sckt {socket.SocketId}] authenticated"); socket.Authenticated = true; return new CallResult(true); } /// - /// The socketConnection received data (the data JToken parameter). The implementation of this method should check if the received data is a response to the query that was send (the request parameter). - /// For example; A query is sent in a request message with an Id parameter with value 10. The socket receives data and calls this method to see if the data it received is an - /// anwser to any query that was done. The implementation of this method should check if the response.Id == request.Id to see if they match (assuming the api has some sort of Id tracking on messages, - /// if not some other method has be implemented to match the messages). - /// If the messages match, the callResult out parameter should be set with the deserialized data in the from of (T) and return true. + /// Should return the request which can be used to authenticate a socket connection /// - /// The type of response that is expected on the query - /// The socket connection - /// The request that a response is awaited for - /// The message received from the server - /// The interpretation (null if message wasn't a response to the request) - /// True if the message was a response to the query - protected internal abstract bool HandleQueryResponse(SocketConnection socketConnection, object request, JToken data, [NotNullWhen(true)] out CallResult? callResult); - - /// - /// The socketConnection received data (the data JToken parameter). The implementation of this method should check if the received data is a response to the subscription request that was send (the request parameter). - /// For example; A subscribe request message is send with an Id parameter with value 10. The socket receives data and calls this method to see if the data it received is an - /// anwser to any subscription request that was done. The implementation of this method should check if the response.Id == request.Id to see if they match (assuming the api has some sort of Id tracking on messages, - /// if not some other method has be implemented to match the messages). - /// If the messages match, the callResult out parameter should be set with the deserialized data in the from of (T) and return true. - /// - /// The socket connection - /// A subscription that waiting for a subscription response - /// The request that the subscription sent - /// The message received from the server - /// The interpretation (null if message wasn't a response to the request) - /// True if the message was a response to the subscription request - protected internal abstract bool HandleSubscriptionResponse(SocketConnection socketConnection, SocketSubscription subscription, object request, JToken data, out CallResult? callResult); - - /// - /// Needs to check if a received message matches a handler by request. After subscribing data message will come in. These data messages need to be matched to a specific connection - /// to pass the correct data to the correct handler. The implementation of this method should check if the message received matches the subscribe request that was sent. - /// - /// The socket connection the message was recieved on - /// The received data - /// The subscription request - /// True if the message is for the subscription which sent the request - protected internal abstract bool MessageMatchesHandler(SocketConnection socketConnection, JToken message, object request); - - /// - /// Needs to check if a received message matches a handler by identifier. Generally used by GenericHandlers. For example; a generic handler is registered which handles ping messages - /// from the server. This method should check if the message received is a ping message and the identifer is the identifier of the GenericHandler - /// - /// The socket connection the message was recieved on - /// The received data - /// The string identifier of the handler - /// True if the message is for the handler which has the identifier - protected internal abstract bool MessageMatchesHandler(SocketConnection socketConnection, JToken message, string identifier); - - /// - /// Needs to authenticate the socket so authenticated queries/subscriptions can be made on this socket connection - /// - /// The socket connection that should be authenticated /// - protected internal abstract Task> AuthenticateSocketAsync(SocketConnection socketConnection); - - /// - /// Needs to unsubscribe a subscription, typically by sending an unsubscribe request. If multiple subscriptions per socket is not allowed this can just return since the socket will be closed anyway - /// - /// The connection on which to unsubscribe - /// The subscription to unsubscribe - /// - protected internal abstract Task UnsubscribeAsync(SocketConnection connection, SocketSubscription subscriptionToUnsub); + protected internal virtual Query? GetAuthenticationRequest() => throw new NotImplementedException(); /// - /// Optional handler to interpolate data before sending it to the handlers + /// Adds a system subscription. Used for example to reply to ping requests /// - /// - /// - protected internal virtual JToken ProcessTokenData(JToken message) + /// The subscription + protected void AddSystemSubscription(SystemSubscription systemSubscription) { - return message; - } - - /// - /// Add a subscription to a connection - /// - /// The type of data the subscription expects - /// The request of the subscription - /// The identifier of the subscription (can be null if request param is used) - /// Whether or not this is a user subscription (counts towards the max amount of handlers on a socket) - /// The socket connection the handler is on - /// The handler of the data received - /// Whether the subscription needs authentication - /// - protected virtual SocketSubscription? AddSubscription(object? request, string? identifier, bool userSubscription, SocketConnection connection, Action> dataHandler, bool authenticated) - { - void InternalHandler(MessageEvent messageEvent) - { - if (typeof(T) == typeof(string)) - { - var stringData = (T)Convert.ChangeType(messageEvent.JsonData.ToString(), typeof(T)); - dataHandler(new DataEvent(stringData, null, OutputOriginalData ? messageEvent.OriginalData : null, messageEvent.ReceivedTimestamp, null)); - return; - } - - var desResult = Deserialize(messageEvent.JsonData); - if (!desResult) - { - _logger.Log(LogLevel.Warning, $"Socket {connection.SocketId} Failed to deserialize data into type {typeof(T)}: {desResult.Error}"); - return; - } - - dataHandler(new DataEvent(desResult.Data, null, OutputOriginalData ? messageEvent.OriginalData : null, messageEvent.ReceivedTimestamp, null)); - } - - var subscription = request == null - ? SocketSubscription.CreateForIdentifier(ExchangeHelpers.NextId(), identifier!, userSubscription, authenticated, InternalHandler) - : SocketSubscription.CreateForRequest(ExchangeHelpers.NextId(), request, userSubscription, authenticated, InternalHandler); - if (!connection.AddSubscription(subscription)) - return null; - return subscription; - } - - /// - /// Adds a generic message handler. Used for example to reply to ping requests - /// - /// The name of the request handler. Needs to be unique - /// The action to execute when receiving a message for this handler (checked by ) - protected void AddGenericHandler(string identifier, Action action) - { - genericHandlers.Add(identifier, action); - var subscription = SocketSubscription.CreateForIdentifier(ExchangeHelpers.NextId(), identifier, false, false, action); + systemSubscriptions.Add(systemSubscription); foreach (var connection in socketConnections.Values) - connection.AddSubscription(subscription); + connection.AddSubscription(systemSubscription); } /// @@ -569,13 +424,13 @@ namespace CryptoExchange.Net } /// - /// Update the original request to send when the connection is restored after disconnecting. Can be used to update an authentication token for example. + /// Update the subscription when the connection is restored after disconnecting. Can be used to update an authentication token for example. /// - /// The original request + /// The subscription /// - protected internal virtual Task> RevitalizeRequestAsync(object request) + protected internal virtual Task RevitalizeRequestAsync(Subscription subscription) { - return Task.FromResult(new CallResult(request)); + return Task.FromResult(new CallResult(null)); } /// @@ -589,11 +444,11 @@ namespace CryptoExchange.Net var socketResult = socketConnections.Where(s => (s.Value.Status == SocketConnection.SocketStatus.None || s.Value.Status == SocketConnection.SocketStatus.Connected) && s.Value.Tag.TrimEnd('/') == address.TrimEnd('/') && (s.Value.ApiClient.GetType() == GetType()) - && (s.Value.Authenticated == authenticated || !authenticated) && s.Value.Connected).OrderBy(s => s.Value.SubscriptionCount).FirstOrDefault(); + && (s.Value.Authenticated == authenticated || !authenticated) && s.Value.Connected).OrderBy(s => s.Value.UserSubscriptionCount).FirstOrDefault(); var result = socketResult.Equals(default(KeyValuePair)) ? null : socketResult.Value; if (result != null) { - if (result.SubscriptionCount < ClientOptions.SocketSubscriptionsCombineTarget || (socketConnections.Count >= (ApiOptions.MaxSocketConnections ?? ClientOptions.MaxSocketConnections) && socketConnections.All(s => s.Value.SubscriptionCount >= ClientOptions.SocketSubscriptionsCombineTarget))) + if (result.UserSubscriptionCount < ClientOptions.SocketSubscriptionsCombineTarget || (socketConnections.Count >= (ApiOptions.MaxSocketConnections ?? ClientOptions.MaxSocketConnections) && socketConnections.All(s => s.Value.UserSubscriptionCount >= ClientOptions.SocketSubscriptionsCombineTarget))) { // Use existing socket if it has less than target connections OR it has the least connections and we can't make new return new CallResult(result); @@ -614,11 +469,12 @@ namespace CryptoExchange.Net var socket = CreateSocket(connectionAddress.Data!); var socketConnection = new SocketConnection(_logger, this, socket, address); socketConnection.UnhandledMessage += HandleUnhandledMessage; - foreach (var kvp in genericHandlers) - { - var handler = SocketSubscription.CreateForIdentifier(ExchangeHelpers.NextId(), kvp.Key, false, false, kvp.Value); - socketConnection.AddSubscription(handler); - } + + foreach (var ptg in PeriodicTaskRegistrations) + socketConnection.QueryPeriodic(ptg.Identifier, ptg.Interval, ptg.QueryDelegate, ptg.Callback); + + foreach (var systemSubscription in systemSubscriptions) + socketConnection.AddSubscription(systemSubscription); return new CallResult(socketConnection); } @@ -626,8 +482,8 @@ namespace CryptoExchange.Net /// /// Process an unhandled message /// - /// The token that wasn't processed - protected virtual void HandleUnhandledMessage(JToken token) + /// The message that wasn't processed + protected virtual void HandleUnhandledMessage(IMessageAccessor message) { } @@ -656,8 +512,6 @@ namespace CryptoExchange.Net protected virtual WebSocketParameters GetWebSocketParameters(string address) => new(new Uri(address), ClientOptions.AutoReconnect) { - DataInterpreterBytes = dataInterpreterBytes, - DataInterpreterString = dataInterpreterString, KeepAliveInterval = KeepAliveInterval, ReconnectInterval = ClientOptions.ReconnectInterval, RateLimiters = RateLimiters, @@ -673,57 +527,10 @@ namespace CryptoExchange.Net protected virtual IWebsocket CreateSocket(string address) { var socket = SocketFactory.CreateWebsocket(_logger, GetWebSocketParameters(address)); - _logger.Log(LogLevel.Debug, $"Socket {socket.Id} new socket created for " + address); + _logger.Log(LogLevel.Debug, $"[Sckt {socket.Id}] created for " + address); return socket; } - /// - /// Periodically sends data over a socket connection - /// - /// Identifier for the periodic send - /// How often - /// Method returning the object to send - protected virtual void SendPeriodic(string identifier, TimeSpan interval, Func objGetter) - { - if (objGetter == null) - throw new ArgumentNullException(nameof(objGetter)); - - periodicEvent = new AsyncResetEvent(); - periodicTask = Task.Run(async () => - { - while (!_disposing) - { - await periodicEvent.WaitAsync(interval).ConfigureAwait(false); - if (_disposing) - break; - - foreach (var socketConnection in socketConnections.Values) - { - if (_disposing) - break; - - if (!socketConnection.Connected) - continue; - - var obj = objGetter(socketConnection); - if (obj == null) - continue; - - _logger.Log(LogLevel.Trace, $"Socket {socketConnection.SocketId} sending periodic {identifier}"); - - try - { - socketConnection.Send(ExchangeHelpers.NextId(), obj, 1); - } - catch (Exception ex) - { - _logger.Log(LogLevel.Warning, $"Socket {socketConnection.SocketId} Periodic send {identifier} failed: " + ex.ToLogString()); - } - } - } - }); - } - /// /// Unsubscribe an update subscription /// @@ -731,7 +538,7 @@ namespace CryptoExchange.Net /// public virtual async Task UnsubscribeAsync(int subscriptionId) { - SocketSubscription? subscription = null; + Subscription? subscription = null; SocketConnection? connection = null; foreach (var socket in socketConnections.Values.ToList()) { @@ -746,7 +553,7 @@ namespace CryptoExchange.Net if (subscription == null || connection == null) return false; - _logger.Log(LogLevel.Information, $"Socket {connection.SocketId} Unsubscribing subscription " + subscriptionId); + _logger.Log(LogLevel.Information, $"[Sckt {connection.SocketId}] unsubscribing subscription " + subscriptionId); await connection.CloseAsync(subscription).ConfigureAwait(false); return true; } @@ -761,7 +568,7 @@ namespace CryptoExchange.Net if (subscription == null) throw new ArgumentNullException(nameof(subscription)); - _logger.Log(LogLevel.Information, $"Socket {subscription.SocketId} Unsubscribing subscription " + subscription.Id); + _logger.Log(LogLevel.Information, $"[Sckt {subscription.SocketId}] Unsubscribing subscription " + subscription.Id); await subscription.CloseAsync().ConfigureAwait(false); } @@ -771,11 +578,11 @@ namespace CryptoExchange.Net /// public virtual async Task UnsubscribeAllAsync() { - var sum = socketConnections.Sum(s => s.Value.SubscriptionCount); + var sum = socketConnections.Sum(s => s.Value.UserSubscriptionCount); if (sum == 0) return; - _logger.Log(LogLevel.Information, $"Unsubscribing all {socketConnections.Sum(s => s.Value.SubscriptionCount)} subscriptions"); + _logger.Log(LogLevel.Information, $"Unsubscribing all {socketConnections.Sum(s => s.Value.UserSubscriptionCount)} subscriptions"); var tasks = new List(); { var socketList = socketConnections.Values; @@ -809,12 +616,26 @@ namespace CryptoExchange.Net public string GetSubscriptionsState() { var sb = new StringBuilder(); - sb.AppendLine($"{socketConnections.Count} connections, {CurrentSubscriptions} subscriptions, kbps: {IncomingKbps}"); + sb.AppendLine($"{GetType().Name}"); + sb.AppendLine($" Connections: {socketConnections.Count}"); + sb.AppendLine($" Subscriptions: {CurrentSubscriptions}"); + sb.AppendLine($" Download speed: {IncomingKbps} kbps"); foreach (var connection in socketConnections) { - sb.AppendLine($" Connection {connection.Key}: {connection.Value.SubscriptionCount} subscriptions, status: {connection.Value.Status}, authenticated: {connection.Value.Authenticated}, kbps: {connection.Value.IncomingKbps}"); + sb.AppendLine($" Id: {connection.Key}"); + sb.AppendLine($" Address: {connection.Value.ConnectionUri}"); + sb.AppendLine($" Subscriptions: {connection.Value.UserSubscriptionCount}"); + sb.AppendLine($" Status: {connection.Value.Status}"); + sb.AppendLine($" Authenticated: {connection.Value.Authenticated}"); + sb.AppendLine($" Download speed: {connection.Value.IncomingKbps} kbps"); + sb.AppendLine($" Subscriptions:"); foreach (var subscription in connection.Value.Subscriptions) - sb.AppendLine($" Subscription {subscription.Id}, authenticated: {subscription.Authenticated}, confirmed: {subscription.Confirmed}"); + { + sb.AppendLine($" Id: {subscription.Id}"); + sb.AppendLine($" Confirmed: {subscription.Confirmed}"); + sb.AppendLine($" Invocations: {subscription.TotalInvocations}"); + sb.AppendLine($" Identifiers: [{string.Join(", ", subscription.ListenerIdentifiers)}]"); + } } return sb.ToString(); } @@ -825,9 +646,7 @@ namespace CryptoExchange.Net public override void Dispose() { _disposing = true; - periodicEvent?.Set(); - periodicEvent?.Dispose(); - if (socketConnections.Sum(s => s.Value.SubscriptionCount) > 0) + if (socketConnections.Sum(s => s.Value.UserSubscriptionCount) > 0) { _logger.Log(LogLevel.Debug, "Disposing socket client, closing all subscriptions"); _ = UnsubscribeAllAsync(); @@ -835,5 +654,20 @@ namespace CryptoExchange.Net semaphoreSlim?.Dispose(); base.Dispose(); } + + /// + /// Get the listener identifier for the message + /// + /// + /// + public abstract string? GetListenerIdentifier(IMessageAccessor messageAccessor); + + /// + /// Preprocess a stream message + /// + /// + /// + /// + public virtual Stream PreprocessStreamMessage(WebSocketMessageType type, Stream stream) => stream; } } diff --git a/CryptoExchange.Net/CommonObjects/Enums.cs b/CryptoExchange.Net/CommonObjects/Enums.cs index 7d1986f..1d73e03 100644 --- a/CryptoExchange.Net/CommonObjects/Enums.cs +++ b/CryptoExchange.Net/CommonObjects/Enums.cs @@ -1,8 +1,4 @@ -using System; -using System.Collections.Generic; -using System.Text; - -namespace CryptoExchange.Net.CommonObjects +namespace CryptoExchange.Net.CommonObjects { /// /// Order type diff --git a/CryptoExchange.Net/CommonObjects/OrderBook.cs b/CryptoExchange.Net/CommonObjects/OrderBook.cs index 31f714d..2703675 100644 --- a/CryptoExchange.Net/CommonObjects/OrderBook.cs +++ b/CryptoExchange.Net/CommonObjects/OrderBook.cs @@ -1,6 +1,5 @@ using System; using System.Collections.Generic; -using System.Text; namespace CryptoExchange.Net.CommonObjects { diff --git a/CryptoExchange.Net/CommonObjects/OrderId.cs b/CryptoExchange.Net/CommonObjects/OrderId.cs index 2827a0e..333e742 100644 --- a/CryptoExchange.Net/CommonObjects/OrderId.cs +++ b/CryptoExchange.Net/CommonObjects/OrderId.cs @@ -1,8 +1,4 @@ -using System; -using System.Collections.Generic; -using System.Text; - -namespace CryptoExchange.Net.CommonObjects +namespace CryptoExchange.Net.CommonObjects { /// /// Id of an order diff --git a/CryptoExchange.Net/CommonObjects/Ticker.cs b/CryptoExchange.Net/CommonObjects/Ticker.cs index e5c527a..4513bf5 100644 --- a/CryptoExchange.Net/CommonObjects/Ticker.cs +++ b/CryptoExchange.Net/CommonObjects/Ticker.cs @@ -1,6 +1,4 @@ -using System; - -namespace CryptoExchange.Net.CommonObjects +namespace CryptoExchange.Net.CommonObjects { /// /// Ticker data diff --git a/CryptoExchange.Net/Converters/EnumConverter.cs b/CryptoExchange.Net/Converters/EnumConverter.cs index eb9c664..5c65abc 100644 --- a/CryptoExchange.Net/Converters/EnumConverter.cs +++ b/CryptoExchange.Net/Converters/EnumConverter.cs @@ -47,7 +47,7 @@ namespace CryptoExchange.Net.Converters mapping = AddMapping(enumType); var stringValue = reader.Value?.ToString(); - if (stringValue == null) + if (stringValue == null || stringValue == "") { // Received null value var emptyResult = GetDefaultValue(objectType, enumType); diff --git a/CryptoExchange.Net/CryptoExchange.Net.csproj b/CryptoExchange.Net/CryptoExchange.Net.csproj index 91c6652..62ef735 100644 --- a/CryptoExchange.Net/CryptoExchange.Net.csproj +++ b/CryptoExchange.Net/CryptoExchange.Net.csproj @@ -6,20 +6,26 @@ CryptoExchange.Net JKorf A base package for implementing cryptocurrency API's - 6.2.5 - 6.2.5 - 6.2.5 + 7.0.0-beta2 + 7.0.0 + 7.0.0 false git https://github.com/JKorf/CryptoExchange.Net.git https://github.com/JKorf/CryptoExchange.Net en + README.md + icon.png true - 6.2.5 - Added support for deserializing null and empty string values to BoolConverter + 7.0.0-beta2 - Updated RevitalizeRequestAsync signature, Removed duplicate logging enable 10.0 MIT + + + + true true @@ -41,7 +47,7 @@ all runtime; build; native; contentfiles; analyzers; buildtransitive - + all runtime; build; native; contentfiles; analyzers; buildtransitive diff --git a/CryptoExchange.Net/ExchangeHelpers.cs b/CryptoExchange.Net/ExchangeHelpers.cs index 988b874..20c759f 100644 --- a/CryptoExchange.Net/ExchangeHelpers.cs +++ b/CryptoExchange.Net/ExchangeHelpers.cs @@ -144,6 +144,16 @@ namespace CryptoExchange.Net } } + /// + /// Return the last unique id that was generated + /// + /// + public static int LastId() + { + lock (_idLock) + return _lastId; + } + /// /// Generate a random string of specified length /// diff --git a/CryptoExchange.Net/Icon/icon.png b/CryptoExchange.Net/Icon/icon.png new file mode 100644 index 0000000..b22379e Binary files /dev/null and b/CryptoExchange.Net/Icon/icon.png differ diff --git a/CryptoExchange.Net/Interfaces/CommonClients/IFuturesClient.cs b/CryptoExchange.Net/Interfaces/CommonClients/IFuturesClient.cs index af6c214..48c9975 100644 --- a/CryptoExchange.Net/Interfaces/CommonClients/IFuturesClient.cs +++ b/CryptoExchange.Net/Interfaces/CommonClients/IFuturesClient.cs @@ -2,7 +2,6 @@ using System.Threading; using System.Threading.Tasks; using CryptoExchange.Net.CommonObjects; -using CryptoExchange.Net.Interfaces.CommonClients; using CryptoExchange.Net.Objects; namespace CryptoExchange.Net.Interfaces.CommonClients diff --git a/CryptoExchange.Net/Interfaces/CommonClients/ISpotClient.cs b/CryptoExchange.Net/Interfaces/CommonClients/ISpotClient.cs index 601786b..15c2fd1 100644 --- a/CryptoExchange.Net/Interfaces/CommonClients/ISpotClient.cs +++ b/CryptoExchange.Net/Interfaces/CommonClients/ISpotClient.cs @@ -1,5 +1,4 @@ using CryptoExchange.Net.CommonObjects; -using CryptoExchange.Net.Interfaces.CommonClients; using CryptoExchange.Net.Objects; using System.Threading; using System.Threading.Tasks; diff --git a/CryptoExchange.Net/Interfaces/ICryptoRestClient.cs b/CryptoExchange.Net/Interfaces/ICryptoRestClient.cs new file mode 100644 index 0000000..5f4928b --- /dev/null +++ b/CryptoExchange.Net/Interfaces/ICryptoRestClient.cs @@ -0,0 +1,34 @@ +using CryptoExchange.Net.Interfaces.CommonClients; +using Microsoft.Extensions.DependencyInjection; +using System; +using System.Collections.Generic; +using System.Text; + +namespace CryptoExchange.Net.Interfaces +{ + /// + /// Client for accessing REST API's for different exchanges + /// + public interface ICryptoRestClient + { + /// + /// Get a list of all registered common ISpotClient types + /// + /// + IEnumerable GetSpotClients(); + + /// + /// Get an ISpotClient implementation by exchange name + /// + /// + /// + ISpotClient? SpotClient(string exchangeName); + + /// + /// Try get + /// + /// + /// + T TryGet(Func createFunc); + } +} diff --git a/CryptoExchange.Net/Interfaces/ICryptoSocketClient.cs b/CryptoExchange.Net/Interfaces/ICryptoSocketClient.cs new file mode 100644 index 0000000..8f946f4 --- /dev/null +++ b/CryptoExchange.Net/Interfaces/ICryptoSocketClient.cs @@ -0,0 +1,21 @@ +using CryptoExchange.Net.Interfaces.CommonClients; +using Microsoft.Extensions.DependencyInjection; +using System; +using System.Collections.Generic; +using System.Text; + +namespace CryptoExchange.Net.Interfaces +{ + /// + /// Client for accessing Websocket API's for different exchanges + /// + public interface ICryptoSocketClient + { + /// + /// Try get a client by type for the service collection + /// + /// + /// + T TryGet(Func createFunc); + } +} diff --git a/CryptoExchange.Net/Interfaces/IMessageProcessor.cs b/CryptoExchange.Net/Interfaces/IMessageProcessor.cs new file mode 100644 index 0000000..6f6115a --- /dev/null +++ b/CryptoExchange.Net/Interfaces/IMessageProcessor.cs @@ -0,0 +1,45 @@ +using CryptoExchange.Net.Objects; +using CryptoExchange.Net.Objects.Sockets; +using CryptoExchange.Net.Sockets; +using CryptoExchange.Net.Sockets.MessageParsing.Interfaces; +using System; +using System.Collections.Generic; +using System.Threading.Tasks; + +namespace CryptoExchange.Net.Interfaces +{ + /// + /// Message processor + /// + public interface IMessageProcessor + { + /// + /// Id of the processor + /// + public int Id { get; } + /// + /// The identifiers for this processor + /// + public HashSet ListenerIdentifiers { get; } + /// + /// Handle a message + /// + /// + /// + /// + Task HandleAsync(SocketConnection connection, DataEvent message); + /// + /// Get the type the message should be deserialized to + /// + /// + /// + Type? GetMessageType(IMessageAccessor messageAccessor); + /// + /// Deserialize a message int oobject of type + /// + /// + /// + /// + object Deserialize(IMessageAccessor accessor, Type type); + } +} diff --git a/CryptoExchange.Net/Interfaces/IRequestFactory.cs b/CryptoExchange.Net/Interfaces/IRequestFactory.cs index bcd1fa9..66ff906 100644 --- a/CryptoExchange.Net/Interfaces/IRequestFactory.cs +++ b/CryptoExchange.Net/Interfaces/IRequestFactory.cs @@ -1,5 +1,4 @@ using CryptoExchange.Net.Objects; -using CryptoExchange.Net.Objects.Options; using System; using System.Net.Http; diff --git a/CryptoExchange.Net/Interfaces/IRestApiClient.cs b/CryptoExchange.Net/Interfaces/IRestApiClient.cs index b82b494..9d96fbd 100644 --- a/CryptoExchange.Net/Interfaces/IRestApiClient.cs +++ b/CryptoExchange.Net/Interfaces/IRestApiClient.cs @@ -1,7 +1,4 @@ -using CryptoExchange.Net.Objects; -using System; - -namespace CryptoExchange.Net.Interfaces +namespace CryptoExchange.Net.Interfaces { /// /// Base rest API client diff --git a/CryptoExchange.Net/Interfaces/IRestClient.cs b/CryptoExchange.Net/Interfaces/IRestClient.cs index 704a4e5..b2510e2 100644 --- a/CryptoExchange.Net/Interfaces/IRestClient.cs +++ b/CryptoExchange.Net/Interfaces/IRestClient.cs @@ -1,6 +1,4 @@ using System; -using CryptoExchange.Net.Authentication; -using CryptoExchange.Net.Objects; using CryptoExchange.Net.Objects.Options; namespace CryptoExchange.Net.Interfaces diff --git a/CryptoExchange.Net/Interfaces/ISocketApiClient.cs b/CryptoExchange.Net/Interfaces/ISocketApiClient.cs index 7d1c3c6..4d45e10 100644 --- a/CryptoExchange.Net/Interfaces/ISocketApiClient.cs +++ b/CryptoExchange.Net/Interfaces/ISocketApiClient.cs @@ -1,7 +1,5 @@ -using CryptoExchange.Net.Objects; -using CryptoExchange.Net.Objects.Options; -using CryptoExchange.Net.Sockets; -using System; +using CryptoExchange.Net.Objects.Options; +using CryptoExchange.Net.Objects.Sockets; using System.Threading.Tasks; namespace CryptoExchange.Net.Interfaces @@ -28,6 +26,14 @@ namespace CryptoExchange.Net.Interfaces /// IWebsocketFactory SocketFactory { get; set; } /// + /// Current client options + /// + SocketExchangeOptions ClientOptions { get; } + /// + /// Current API options + /// + SocketApiOptions ApiOptions { get; } + /// /// Log the current state of connections and subscriptions /// string GetSubscriptionsState(); diff --git a/CryptoExchange.Net/Interfaces/ISocketClient.cs b/CryptoExchange.Net/Interfaces/ISocketClient.cs index e2e7f97..514760b 100644 --- a/CryptoExchange.Net/Interfaces/ISocketClient.cs +++ b/CryptoExchange.Net/Interfaces/ISocketClient.cs @@ -1,9 +1,7 @@ using System; using System.Threading.Tasks; -using CryptoExchange.Net.Authentication; -using CryptoExchange.Net.Objects; using CryptoExchange.Net.Objects.Options; -using CryptoExchange.Net.Sockets; +using CryptoExchange.Net.Objects.Sockets; namespace CryptoExchange.Net.Interfaces { diff --git a/CryptoExchange.Net/Interfaces/IWebsocket.cs b/CryptoExchange.Net/Interfaces/IWebsocket.cs index 1c6bfc6..7dc9736 100644 --- a/CryptoExchange.Net/Interfaces/IWebsocket.cs +++ b/CryptoExchange.Net/Interfaces/IWebsocket.cs @@ -1,8 +1,6 @@ -using CryptoExchange.Net.Objects; -using CryptoExchange.Net.Sockets; -using System; -using System.Security.Authentication; -using System.Text; +using System; +using System.IO; +using System.Net.WebSockets; using System.Threading.Tasks; namespace CryptoExchange.Net.Interfaces @@ -15,31 +13,31 @@ namespace CryptoExchange.Net.Interfaces /// /// Websocket closed event /// - event Action OnClose; + event Func OnClose; /// /// Websocket message received event /// - event Action OnMessage; + event Func OnStreamMessage; /// /// Websocket sent event, RequestId as parameter /// - event Action OnRequestSent; + event Func OnRequestSent; /// /// Websocket error event /// - event Action OnError; + event Func OnError; /// /// Websocket opened event /// - event Action OnOpen; + event Func OnOpen; /// /// Websocket has lost connection to the server and is attempting to reconnect /// - event Action OnReconnecting; + event Func OnReconnecting; /// /// Websocket has reconnected to the server /// - event Action OnReconnected; + event Func OnReconnected; /// /// Get reconntion url /// diff --git a/CryptoExchange.Net/Interfaces/IWebsocketFactory.cs b/CryptoExchange.Net/Interfaces/IWebsocketFactory.cs index a8304da..3fe70c1 100644 --- a/CryptoExchange.Net/Interfaces/IWebsocketFactory.cs +++ b/CryptoExchange.Net/Interfaces/IWebsocketFactory.cs @@ -1,4 +1,4 @@ -using CryptoExchange.Net.Sockets; +using CryptoExchange.Net.Objects.Sockets; using Microsoft.Extensions.Logging; namespace CryptoExchange.Net.Interfaces diff --git a/CryptoExchange.Net/Objects/CallResult.cs b/CryptoExchange.Net/Objects/CallResult.cs index c72f470..be9b783 100644 --- a/CryptoExchange.Net/Objects/CallResult.cs +++ b/CryptoExchange.Net/Objects/CallResult.cs @@ -70,7 +70,7 @@ namespace CryptoExchange.Net.Objects /// /// #pragma warning disable 8618 - protected CallResult([AllowNull]T data, string? originalData, Error? error): base(error) + public CallResult([AllowNull]T data, string? originalData, Error? error): base(error) #pragma warning restore 8618 { OriginalData = originalData; @@ -91,6 +91,13 @@ namespace CryptoExchange.Net.Objects /// The erro rto return public CallResult(Error error) : this(default, null, error) { } + /// + /// Create a new error result + /// + /// The error to return + /// The original response data + public CallResult(Error error, string? originalData) : this(default, originalData, error) { } + /// /// Overwrite bool check so we can use if(callResult) instead of if(callResult.Success) /// diff --git a/CryptoExchange.Net/Objects/Error.cs b/CryptoExchange.Net/Objects/Error.cs index 580a014..74232dd 100644 --- a/CryptoExchange.Net/Objects/Error.cs +++ b/CryptoExchange.Net/Objects/Error.cs @@ -278,7 +278,7 @@ namespace CryptoExchange.Net.Objects /// /// /// - protected CancellationRequestedError(int? code, string message, object? data): base(code, message, data) { } + public CancellationRequestedError(int? code, string message, object? data): base(code, message, data) { } } /// diff --git a/CryptoExchange.Net/Sockets/DataEvent.cs b/CryptoExchange.Net/Objects/Sockets/DataEvent.cs similarity index 97% rename from CryptoExchange.Net/Sockets/DataEvent.cs rename to CryptoExchange.Net/Objects/Sockets/DataEvent.cs index d6e3151..bfd9db3 100644 --- a/CryptoExchange.Net/Sockets/DataEvent.cs +++ b/CryptoExchange.Net/Objects/Sockets/DataEvent.cs @@ -1,7 +1,6 @@ -using CryptoExchange.Net.Objects; -using System; +using System; -namespace CryptoExchange.Net.Sockets +namespace CryptoExchange.Net.Objects.Sockets { /// /// An update received from a socket update subscription diff --git a/CryptoExchange.Net/Sockets/UpdateSubscription.cs b/CryptoExchange.Net/Objects/Sockets/UpdateSubscription.cs similarity index 83% rename from CryptoExchange.Net/Sockets/UpdateSubscription.cs rename to CryptoExchange.Net/Objects/Sockets/UpdateSubscription.cs index 64cf082..9f43e94 100644 --- a/CryptoExchange.Net/Sockets/UpdateSubscription.cs +++ b/CryptoExchange.Net/Objects/Sockets/UpdateSubscription.cs @@ -1,8 +1,8 @@ -using CryptoExchange.Net.Objects; +using CryptoExchange.Net.Sockets; using System; using System.Threading.Tasks; -namespace CryptoExchange.Net.Sockets +namespace CryptoExchange.Net.Objects.Sockets { /// /// Subscription to a data stream @@ -10,7 +10,7 @@ namespace CryptoExchange.Net.Sockets public class UpdateSubscription { private readonly SocketConnection _connection; - private readonly SocketSubscription _subscription; + private readonly Subscription _listener; /// /// Event when the connection is lost. The socket will automatically reconnect when possible. @@ -64,8 +64,8 @@ namespace CryptoExchange.Net.Sockets /// public event Action Exception { - add => _subscription.Exception += value; - remove => _subscription.Exception -= value; + add => _listener.Exception += value; + remove => _listener.Exception -= value; } /// @@ -76,26 +76,26 @@ namespace CryptoExchange.Net.Sockets /// /// The id of the subscription /// - public int Id => _subscription.Id; + public int Id => _listener.Id; /// /// ctor /// /// The socket connection the subscription is on /// The subscription - public UpdateSubscription(SocketConnection connection, SocketSubscription subscription) + public UpdateSubscription(SocketConnection connection, Subscription subscription) { - this._connection = connection; - this._subscription = subscription; + _connection = connection; + _listener = subscription; } - + /// /// Close the subscription /// /// public Task CloseAsync() { - return _connection.CloseAsync(_subscription); + return _connection.CloseAsync(_listener); } /// @@ -113,16 +113,16 @@ namespace CryptoExchange.Net.Sockets /// internal async Task UnsubscribeAsync() { - await _connection.UnsubscribeAsync(_subscription).ConfigureAwait(false); + await _connection.UnsubscribeAsync(_listener).ConfigureAwait(false); } /// /// Resubscribe this subscription /// /// - internal async Task> ResubscribeAsync() + internal async Task ResubscribeAsync() { - return await _connection.ResubscribeAsync(_subscription).ConfigureAwait(false); + return await _connection.ResubscribeAsync(_listener).ConfigureAwait(false); } } } diff --git a/CryptoExchange.Net/Sockets/WebSocketParameters.cs b/CryptoExchange.Net/Objects/Sockets/WebSocketParameters.cs similarity index 75% rename from CryptoExchange.Net/Sockets/WebSocketParameters.cs rename to CryptoExchange.Net/Objects/Sockets/WebSocketParameters.cs index a20b296..4d05b6e 100644 --- a/CryptoExchange.Net/Sockets/WebSocketParameters.cs +++ b/CryptoExchange.Net/Objects/Sockets/WebSocketParameters.cs @@ -1,11 +1,9 @@ using CryptoExchange.Net.Interfaces; -using CryptoExchange.Net.Objects; using System; using System.Collections.Generic; using System.Text; -using System.Threading.Tasks; -namespace CryptoExchange.Net.Sockets +namespace CryptoExchange.Net.Objects.Sockets { /// /// Parameters for a websocket @@ -57,21 +55,6 @@ namespace CryptoExchange.Net.Sockets /// public IEnumerable? RateLimiters { get; set; } - /// - /// Origin header value to send in the connection handshake - /// - public string? Origin { get; set; } - - /// - /// Delegate used for processing byte data received from socket connections before it is processed by handlers - /// - public Func? DataInterpreterBytes { get; set; } - - /// - /// Delegate used for processing string data received from socket connections before it is processed by handlers - /// - public Func? DataInterpreterString { get; set; } - /// /// Encoding for sending/receiving data /// diff --git a/CryptoExchange.Net/Objects/TradeEnvironment.cs b/CryptoExchange.Net/Objects/TradeEnvironment.cs index 7ca760c..70dcbae 100644 --- a/CryptoExchange.Net/Objects/TradeEnvironment.cs +++ b/CryptoExchange.Net/Objects/TradeEnvironment.cs @@ -1,6 +1,4 @@ -using System.Collections.Generic; - -namespace CryptoExchange.Net.Objects +namespace CryptoExchange.Net.Objects { /// /// Trade environment names diff --git a/CryptoExchange.Net/OrderBook/SymbolOrderBook.cs b/CryptoExchange.Net/OrderBook/SymbolOrderBook.cs index d6404f4..5d019d2 100644 --- a/CryptoExchange.Net/OrderBook/SymbolOrderBook.cs +++ b/CryptoExchange.Net/OrderBook/SymbolOrderBook.cs @@ -9,7 +9,7 @@ using System.Threading.Tasks; using CryptoExchange.Net.Interfaces; using CryptoExchange.Net.Objects; using CryptoExchange.Net.Objects.Options; -using CryptoExchange.Net.Sockets; +using CryptoExchange.Net.Objects.Sockets; using Microsoft.Extensions.Logging; namespace CryptoExchange.Net.OrderBook diff --git a/CryptoExchange.Net/Requests/RequestFactory.cs b/CryptoExchange.Net/Requests/RequestFactory.cs index 63d897c..b909870 100644 --- a/CryptoExchange.Net/Requests/RequestFactory.cs +++ b/CryptoExchange.Net/Requests/RequestFactory.cs @@ -1,10 +1,8 @@ using System; using System.Net; using System.Net.Http; -using System.Runtime.InteropServices; using CryptoExchange.Net.Interfaces; using CryptoExchange.Net.Objects; -using CryptoExchange.Net.Objects.Options; namespace CryptoExchange.Net.Requests { diff --git a/CryptoExchange.Net/Sockets/CryptoExchangeWebSocketClient.cs b/CryptoExchange.Net/Sockets/CryptoExchangeWebSocketClient.cs index 3c9ab9b..d2936f1 100644 --- a/CryptoExchange.Net/Sockets/CryptoExchangeWebSocketClient.cs +++ b/CryptoExchange.Net/Sockets/CryptoExchangeWebSocketClient.cs @@ -1,5 +1,6 @@ using CryptoExchange.Net.Interfaces; using CryptoExchange.Net.Objects; +using CryptoExchange.Net.Objects.Sockets; using Microsoft.Extensions.Logging; using System; using System.Collections.Concurrent; @@ -44,7 +45,6 @@ namespace CryptoExchange.Net.Sockets private ProcessState _processState; private DateTime _lastReconnectTime; - /// /// Received messages, the size and the timstamp /// @@ -75,10 +75,10 @@ namespace CryptoExchange.Net.Sockets public Uri Uri => Parameters.Uri; /// - public bool IsClosed => _socket.State == WebSocketState.Closed; + public virtual bool IsClosed => _socket.State == WebSocketState.Closed; /// - public bool IsOpen => _socket.State == WebSocketState.Open && !_ctsSource.IsCancellationRequested; + public virtual bool IsOpen => _socket.State == WebSocketState.Open && !_ctsSource.IsCancellationRequested; /// public double IncomingKbps @@ -98,25 +98,25 @@ namespace CryptoExchange.Net.Sockets } /// - public event Action? OnClose; + public event Func? OnClose; /// - public event Action? OnMessage; + public event Func? OnStreamMessage; /// - public event Action? OnRequestSent; + public event Func? OnRequestSent; /// - public event Action? OnError; + public event Func? OnError; /// - public event Action? OnOpen; + public event Func? OnOpen; /// - public event Action? OnReconnecting; + public event Func? OnReconnecting; /// - public event Action? OnReconnected; + public event Func? OnReconnected; /// public Func>? GetReconnectionUrl { get; set; } @@ -147,7 +147,7 @@ namespace CryptoExchange.Net.Sockets if (!await ConnectInternalAsync().ConfigureAwait(false)) return false; - OnOpen?.Invoke(); + await (OnOpen?.Invoke() ?? Task.CompletedTask).ConfigureAwait(false); _processTask = ProcessAsync(); return true; } @@ -183,7 +183,7 @@ namespace CryptoExchange.Net.Sockets private async Task ConnectInternalAsync() { - _logger.Log(LogLevel.Debug, $"Socket {Id} connecting"); + _logger.Log(LogLevel.Debug, $"[Sckt {Id}] connecting"); try { using CancellationTokenSource tcs = new(TimeSpan.FromSeconds(10)); @@ -191,11 +191,11 @@ namespace CryptoExchange.Net.Sockets } catch (Exception e) { - _logger.Log(LogLevel.Debug, $"Socket {Id} connection failed: " + e.ToLogString()); + _logger.Log(LogLevel.Debug, $"[Sckt {Id}] connection failed: " + e.ToLogString()); return false; } - _logger.Log(LogLevel.Debug, $"Socket {Id} connected to {Uri}"); + _logger.Log(LogLevel.Debug, $"[Sckt {Id}] connected to {Uri}"); return true; } @@ -204,13 +204,13 @@ namespace CryptoExchange.Net.Sockets { while (!_stopRequested) { - _logger.Log(LogLevel.Debug, $"Socket {Id} starting processing tasks"); + _logger.Log(LogLevel.Debug, $"[Sckt {Id}] starting processing tasks"); _processState = ProcessState.Processing; var sendTask = SendLoopAsync(); var receiveTask = ReceiveLoopAsync(); var timeoutTask = Parameters.Timeout != null && Parameters.Timeout > TimeSpan.FromSeconds(0) ? CheckTimeoutAsync() : Task.CompletedTask; await Task.WhenAll(sendTask, receiveTask, timeoutTask).ConfigureAwait(false); - _logger.Log(LogLevel.Debug, $"Socket {Id} processing tasks finished"); + _logger.Log(LogLevel.Debug, $"[Sckt {Id}] processing tasks finished"); _processState = ProcessState.WaitingForClose; while (_closeTask == null) @@ -222,14 +222,14 @@ namespace CryptoExchange.Net.Sockets if (!Parameters.AutoReconnect) { _processState = ProcessState.Idle; - OnClose?.Invoke(); + await (OnClose?.Invoke() ?? Task.CompletedTask).ConfigureAwait(false); return; } if (!_stopRequested) { _processState = ProcessState.Reconnecting; - OnReconnecting?.Invoke(); + await (OnReconnecting?.Invoke() ?? Task.CompletedTask).ConfigureAwait(false); } var sinceLastReconnect = DateTime.UtcNow - _lastReconnectTime; @@ -238,14 +238,14 @@ namespace CryptoExchange.Net.Sockets while (!_stopRequested) { - _logger.Log(LogLevel.Debug, $"Socket {Id} attempting to reconnect"); + _logger.Log(LogLevel.Debug, $"[Sckt {Id}] attempting to reconnect"); var task = GetReconnectionUrl?.Invoke(); if (task != null) { var reconnectUri = await task.ConfigureAwait(false); if (reconnectUri != null && Parameters.Uri != reconnectUri) { - _logger.Log(LogLevel.Debug, $"Socket {Id} reconnect URI set to {reconnectUri}"); + _logger.Log(LogLevel.Debug, $"[Sckt {Id}] reconnect URI set to {reconnectUri}"); Parameters.Uri = reconnectUri; } } @@ -263,7 +263,7 @@ namespace CryptoExchange.Net.Sockets } _lastReconnectTime = DateTime.UtcNow; - OnReconnected?.Invoke(); + await (OnReconnected?.Invoke() ?? Task.CompletedTask).ConfigureAwait(false); break; } } @@ -278,7 +278,7 @@ namespace CryptoExchange.Net.Sockets return; var bytes = Parameters.Encoding.GetBytes(data); - _logger.Log(LogLevel.Trace, $"Socket {Id} - msg {id} - Adding {bytes.Length} bytes to send buffer"); + _logger.Log(LogLevel.Trace, $"[Sckt {Id}] msg {id} - Adding {bytes.Length} bytes to send buffer"); _sendBuffer.Enqueue(new SendItem { Id = id, Weight = weight, Bytes = bytes }); _sendEvent.Set(); } @@ -289,7 +289,7 @@ namespace CryptoExchange.Net.Sockets if (_processState != ProcessState.Processing && IsOpen) return; - _logger.Log(LogLevel.Debug, $"Socket {Id} reconnect requested"); + _logger.Log(LogLevel.Debug, $"[Sckt {Id}] reconnect requested"); _closeTask = CloseInternalAsync(); await _closeTask.ConfigureAwait(false); } @@ -304,18 +304,18 @@ namespace CryptoExchange.Net.Sockets { if (_closeTask?.IsCompleted == false) { - _logger.Log(LogLevel.Debug, $"Socket {Id} CloseAsync() waiting for existing close task"); + _logger.Log(LogLevel.Debug, $"[Sckt {Id}] CloseAsync() waiting for existing close task"); await _closeTask.ConfigureAwait(false); return; } if (!IsOpen) { - _logger.Log(LogLevel.Debug, $"Socket {Id} CloseAsync() socket not open"); + _logger.Log(LogLevel.Debug, $"[Sckt {Id}] CloseAsync() socket not open"); return; } - _logger.Log(LogLevel.Debug, $"Socket {Id} closing"); + _logger.Log(LogLevel.Debug, $"[Sckt {Id}] closing"); _closeTask = CloseInternalAsync(); } finally @@ -326,8 +326,8 @@ namespace CryptoExchange.Net.Sockets await _closeTask.ConfigureAwait(false); if(_processTask != null) await _processTask.ConfigureAwait(false); - OnClose?.Invoke(); - _logger.Log(LogLevel.Debug, $"Socket {Id} closed"); + await (OnClose?.Invoke() ?? Task.CompletedTask).ConfigureAwait(false); + _logger.Log(LogLevel.Debug, $"[Sckt {Id}] closed"); } /// @@ -379,11 +379,11 @@ namespace CryptoExchange.Net.Sockets if (_disposed) return; - _logger.Log(LogLevel.Debug, $"Socket {Id} disposing"); + _logger.Log(LogLevel.Debug, $"[Sckt {Id}] disposing"); _disposed = true; _socket.Dispose(); _ctsSource.Dispose(); - _logger.Log(LogLevel.Trace, $"Socket {Id} disposed"); + _logger.Log(LogLevel.Trace, $"[Sckt {Id}] disposed"); } /// @@ -415,7 +415,7 @@ namespace CryptoExchange.Net.Sockets if (limitResult.Success) { if (limitResult.Data > 0) - _logger.Log(LogLevel.Debug, $"Socket {Id} - msg {data.Id} - send delayed {limitResult.Data}ms because of rate limit"); + _logger.Log(LogLevel.Debug, $"[Sckt {Id}] msg {data.Id} - send delayed {limitResult.Data}ms because of rate limit"); } } } @@ -423,8 +423,8 @@ namespace CryptoExchange.Net.Sockets try { await _socket.SendAsync(new ArraySegment(data.Bytes, 0, data.Bytes.Length), WebSocketMessageType.Text, true, _ctsSource.Token).ConfigureAwait(false); - OnRequestSent?.Invoke(data.Id); - _logger.Log(LogLevel.Trace, $"Socket {Id} - msg {data.Id} - sent {data.Bytes.Length} bytes"); + await (OnRequestSent?.Invoke(data.Id) ?? Task.CompletedTask).ConfigureAwait(false); + _logger.Log(LogLevel.Trace, $"[Sckt {Id}] msg {data.Id} - sent {data.Bytes.Length} bytes"); } catch (OperationCanceledException) { @@ -434,7 +434,7 @@ namespace CryptoExchange.Net.Sockets catch (Exception ioe) { // Connection closed unexpectedly, .NET framework - OnError?.Invoke(ioe); + await (OnError?.Invoke(ioe) ?? Task.CompletedTask).ConfigureAwait(false); if (_closeTask?.IsCompleted != false) _closeTask = CloseInternalAsync(); break; @@ -447,13 +447,13 @@ namespace CryptoExchange.Net.Sockets // Because this is running in a separate task and not awaited until the socket gets closed // any exception here will crash the send processing, but do so silently unless the socket get's stopped. // Make sure we at least let the owner know there was an error - _logger.Log(LogLevel.Warning, $"Socket {Id} Send loop stopped with exception"); - OnError?.Invoke(e); + _logger.Log(LogLevel.Warning, $"[Sckt {Id}] send loop stopped with exception"); + await (OnError?.Invoke(e) ?? Task.CompletedTask).ConfigureAwait(false); throw; } finally { - _logger.Log(LogLevel.Debug, $"Socket {Id} Send loop finished"); + _logger.Log(LogLevel.Debug, $"[Sckt {Id}] send loop finished"); } } @@ -492,7 +492,7 @@ namespace CryptoExchange.Net.Sockets catch (Exception wse) { // Connection closed unexpectedly - OnError?.Invoke(wse); + await (OnError?.Invoke(wse) ?? Task.CompletedTask).ConfigureAwait(false); if (_closeTask?.IsCompleted != false) _closeTask = CloseInternalAsync(); break; @@ -501,7 +501,7 @@ namespace CryptoExchange.Net.Sockets if (receiveResult.MessageType == WebSocketMessageType.Close) { // Connection closed unexpectedly - _logger.Log(LogLevel.Debug, $"Socket {Id} received `Close` message"); + _logger.Log(LogLevel.Debug, $"[Sckt {Id}] received `Close` message"); if (_closeTask?.IsCompleted != false) _closeTask = CloseInternalAsync(); break; @@ -512,7 +512,7 @@ namespace CryptoExchange.Net.Sockets // We received data, but it is not complete, write it to a memory stream for reassembling multiPartMessage = true; memoryStream ??= new MemoryStream(); - _logger.Log(LogLevel.Trace, $"Socket {Id} received {receiveResult.Count} bytes in partial message"); + _logger.Log(LogLevel.Trace, $"[Sckt {Id}] received {receiveResult.Count} bytes in partial message"); await memoryStream.WriteAsync(buffer.Array, buffer.Offset, receiveResult.Count).ConfigureAwait(false); } else @@ -520,13 +520,13 @@ namespace CryptoExchange.Net.Sockets if (!multiPartMessage) { // Received a complete message and it's not multi part - _logger.Log(LogLevel.Trace, $"Socket {Id} received {receiveResult.Count} bytes in single message"); - HandleMessage(buffer.Array!, buffer.Offset, receiveResult.Count, receiveResult.MessageType); + _logger.Log(LogLevel.Trace, $"[Sckt {Id}] received {receiveResult.Count} bytes in single message"); + await ProcessData(receiveResult.MessageType, new MemoryStream(buffer.Array, buffer.Offset, receiveResult.Count)).ConfigureAwait(false); } else { // Received the end of a multipart message, write to memory stream for reassembling - _logger.Log(LogLevel.Trace, $"Socket {Id} received {receiveResult.Count} bytes in partial message"); + _logger.Log(LogLevel.Trace, $"[Sckt {Id}] received {receiveResult.Count} bytes in partial message"); await memoryStream!.WriteAsync(buffer.Array, buffer.Offset, receiveResult.Count).ConfigureAwait(false); } break; @@ -554,12 +554,14 @@ namespace CryptoExchange.Net.Sockets if (receiveResult?.EndOfMessage == true) { // Reassemble complete message from memory stream - _logger.Log(LogLevel.Trace, $"Socket {Id} reassembled message of {memoryStream!.Length} bytes"); - HandleMessage(memoryStream!.ToArray(), 0, (int)memoryStream.Length, receiveResult.MessageType); + _logger.Log(LogLevel.Trace, $"[Sckt {Id}] reassembled message of {memoryStream!.Length} bytes"); + await ProcessData(receiveResult.MessageType, memoryStream).ConfigureAwait(false); memoryStream.Dispose(); } else - _logger.Log(LogLevel.Trace, $"Socket {Id} discarding incomplete message of {memoryStream!.Length} bytes"); + { + _logger.Log(LogLevel.Trace, $"[Sckt {Id}] discarding incomplete message of {memoryStream!.Length} bytes"); + } } } } @@ -568,68 +570,29 @@ namespace CryptoExchange.Net.Sockets // Because this is running in a separate task and not awaited until the socket gets closed // any exception here will crash the receive processing, but do so silently unless the socket gets stopped. // Make sure we at least let the owner know there was an error - _logger.Log(LogLevel.Warning, $"Socket {Id} Receive loop stopped with exception"); - OnError?.Invoke(e); + _logger.Log(LogLevel.Warning, $"[Sckt {Id}] receive loop stopped with exception"); + await (OnError?.Invoke(e) ?? Task.CompletedTask).ConfigureAwait(false); throw; } finally { - _logger.Log(LogLevel.Debug, $"Socket {Id} Receive loop finished"); + _logger.Log(LogLevel.Debug, $"[Sckt {Id}] receive loop finished"); } } /// - /// Handles the message + /// Proccess a stream message /// - /// - /// - /// - /// - private void HandleMessage(byte[] data, int offset, int count, WebSocketMessageType messageType) + /// + /// + /// + protected async Task ProcessData(WebSocketMessageType type, Stream stream) { - string strData; - if (messageType == WebSocketMessageType.Binary) - { - if (Parameters.DataInterpreterBytes == null) - throw new Exception("Byte interpreter not set while receiving byte data"); + LastActionTime = DateTime.UtcNow; + stream.Position = 0; - try - { - var relevantData = new byte[count]; - Array.Copy(data, offset, relevantData, 0, count); - strData = Parameters.DataInterpreterBytes(relevantData); - } - catch(Exception e) - { - _logger.Log(LogLevel.Error, $"Socket {Id} unhandled exception during byte data interpretation: " + e.ToLogString()); - return; - } - } - else - strData = Parameters.Encoding.GetString(data, offset, count); - - if (Parameters.DataInterpreterString != null) - { - try - { - strData = Parameters.DataInterpreterString(strData); - } - catch(Exception e) - { - _logger.Log(LogLevel.Error, $"Socket {Id} unhandled exception during string data interpretation: " + e.ToLogString()); - return; - } - } - - try - { - LastActionTime = DateTime.UtcNow; - OnMessage?.Invoke(strData); - } - catch(Exception e) - { - _logger.Log(LogLevel.Error, $"Socket {Id} unhandled exception during message processing: " + e.ToLogString()); - } + if (OnStreamMessage != null) + await OnStreamMessage.Invoke(type, stream).ConfigureAwait(false); } /// @@ -638,7 +601,7 @@ namespace CryptoExchange.Net.Sockets /// protected async Task CheckTimeoutAsync() { - _logger.Log(LogLevel.Debug, $"Socket {Id} Starting task checking for no data received for {Parameters.Timeout}"); + _logger.Log(LogLevel.Debug, $"[Sckt {Id}] starting task checking for no data received for {Parameters.Timeout}"); LastActionTime = DateTime.UtcNow; try { @@ -649,7 +612,7 @@ namespace CryptoExchange.Net.Sockets if (DateTime.UtcNow - LastActionTime > Parameters.Timeout) { - _logger.Log(LogLevel.Warning, $"Socket {Id} No data received for {Parameters.Timeout}, reconnecting socket"); + _logger.Log(LogLevel.Warning, $"[Sckt {Id}] no data received for {Parameters.Timeout}, reconnecting socket"); _ = ReconnectAsync().ConfigureAwait(false); return; } @@ -669,7 +632,7 @@ namespace CryptoExchange.Net.Sockets // Because this is running in a separate task and not awaited until the socket gets closed // any exception here will stop the timeout checking, but do so silently unless the socket get's stopped. // Make sure we at least let the owner know there was an error - OnError?.Invoke(e); + await (OnError?.Invoke(e) ?? Task.CompletedTask).ConfigureAwait(false); throw; } } diff --git a/CryptoExchange.Net/Sockets/MessageEvent.cs b/CryptoExchange.Net/Sockets/MessageEvent.cs deleted file mode 100644 index ae12e0f..0000000 --- a/CryptoExchange.Net/Sockets/MessageEvent.cs +++ /dev/null @@ -1,46 +0,0 @@ -using Newtonsoft.Json.Linq; -using System; - -namespace CryptoExchange.Net.Sockets -{ - /// - /// Message received event - /// - public class MessageEvent - { - /// - /// The connection the message was received on - /// - public SocketConnection Connection { get; set; } - - /// - /// The json object of the data - /// - public JToken JsonData { get; set; } - - /// - /// The originally received string data - /// - public string? OriginalData { get; set; } - - /// - /// The timestamp of when the data was received - /// - public DateTime ReceivedTimestamp { get; set; } - - /// - /// ctor - /// - /// - /// - /// - /// - public MessageEvent(SocketConnection connection, JToken jsonData, string? originalData, DateTime timestamp) - { - Connection = connection; - JsonData = jsonData; - OriginalData = originalData; - ReceivedTimestamp = timestamp; - } - } -} diff --git a/CryptoExchange.Net/Sockets/MessageParsing/Interfaces/IMessageData.cs b/CryptoExchange.Net/Sockets/MessageParsing/Interfaces/IMessageData.cs new file mode 100644 index 0000000..9c76270 --- /dev/null +++ b/CryptoExchange.Net/Sockets/MessageParsing/Interfaces/IMessageData.cs @@ -0,0 +1,58 @@ +using System; +using System.Collections.Generic; +using System.IO; + +namespace CryptoExchange.Net.Sockets.MessageParsing.Interfaces +{ + /// + /// Message accessor + /// + public interface IMessageAccessor + { + /// + /// Is this a json message + /// + bool IsJson { get; } + /// + /// The underlying data object + /// + object? Underlying { get; } + /// + /// Load a stream message + /// + /// + void Load(Stream stream); + /// + /// Get the type of node + /// + /// + NodeType? GetNodeType(); + /// + /// Get the type of node + /// + /// Access path + /// + NodeType? GetNodeType(MessagePath path); + /// + /// Get the value of a path + /// + /// + /// + /// + T? GetValue(MessagePath path); + /// + /// Get the values of an array + /// + /// + /// + /// + List? GetValues(MessagePath path); + /// + /// Deserialize the message into this type + /// + /// + /// + /// + object Deserialize(Type type, MessagePath? path = null); + } +} diff --git a/CryptoExchange.Net/Sockets/MessageParsing/Interfaces/IMessageSerializer.cs b/CryptoExchange.Net/Sockets/MessageParsing/Interfaces/IMessageSerializer.cs new file mode 100644 index 0000000..8df3e5e --- /dev/null +++ b/CryptoExchange.Net/Sockets/MessageParsing/Interfaces/IMessageSerializer.cs @@ -0,0 +1,15 @@ +namespace CryptoExchange.Net.Sockets.MessageParsing.Interfaces +{ + /// + /// Serializer interface + /// + public interface IMessageSerializer + { + /// + /// Serialize an object to a string + /// + /// + /// + string Serialize(object message); + } +} diff --git a/CryptoExchange.Net/Sockets/MessageParsing/JsonNetMessageData.cs b/CryptoExchange.Net/Sockets/MessageParsing/JsonNetMessageData.cs new file mode 100644 index 0000000..e3606d7 --- /dev/null +++ b/CryptoExchange.Net/Sockets/MessageParsing/JsonNetMessageData.cs @@ -0,0 +1,158 @@ +using CryptoExchange.Net.Converters; +using CryptoExchange.Net.Sockets.MessageParsing.Interfaces; +using Newtonsoft.Json; +using Newtonsoft.Json.Linq; +using System; +using System.Collections.Generic; +using System.IO; +using System.Linq; +using System.Text; + +namespace CryptoExchange.Net.Sockets.MessageParsing +{ + /// + /// Json.Net message accessor + /// + public class JsonNetMessageAccessor : IMessageAccessor + { + private JToken? _token; + private Stream? _stream; + private static JsonSerializer _serializer = JsonSerializer.Create(SerializerOptions.WithConverters); + + /// + public bool IsJson { get; private set; } + + /// + public object? Underlying => _token; + + /// + public void Load(Stream stream) + { + _stream = stream; + using var reader = new StreamReader(stream, Encoding.UTF8, false, (int)stream.Length, true); + using var jsonTextReader = new JsonTextReader(reader); + + try + { + _token = JToken.Load(jsonTextReader); + IsJson = true; + } + catch (Exception) + { + // Not a json message + IsJson = false; + } + } + + /// + public object Deserialize(Type type, MessagePath? path = null) + { + if (!IsJson) + { + var sr = new StreamReader(_stream); + return sr.ReadToEnd(); + } + + var source = _token; + if (path != null) + source = GetPathNode(path.Value); + + return source!.ToObject(type, _serializer)!; + } + + /// + public NodeType? GetNodeType() + { + if (_token == null) + return null; + + if (_token.Type == JTokenType.Object) + return NodeType.Object; + + if (_token.Type == JTokenType.Array) + return NodeType.Array; + + return NodeType.Value; + } + + /// + public NodeType? GetNodeType(MessagePath path) + { + var node = GetPathNode(path); + if (node == null) + return null; + + if (node.Type == JTokenType.Object) + return NodeType.Object; + + if (node.Type == JTokenType.Array) + return NodeType.Array; + + return NodeType.Value; + } + + /// + public T? GetValue(MessagePath path) + { + var value = GetPathNode(path); + if (value == null) + return default; + + if (value.Type == JTokenType.Object || value.Type == JTokenType.Array) + return default; + + return value!.Value(); + } + + /// + public List? GetValues(MessagePath path) + { + var value = GetPathNode(path); + if (value == null) + return default; + + if (value.Type == JTokenType.Object) + return default; + + return value!.Values().ToList(); + } + + private JToken? GetPathNode(MessagePath path) + { + var currentToken = _token; + foreach (var node in path) + { + if (node.Type == 0) + { + // Int value + var val = (int)node.Value!; + if (currentToken!.Type != JTokenType.Array || ((JArray)currentToken).Count <= val) + return null; + + currentToken = currentToken[val]; + } + else if (node.Type == 1) + { + // String value + if (currentToken!.Type != JTokenType.Object) + return null; + + currentToken = currentToken[(string)node.Value!]; + } + else + { + // Property name + if (currentToken!.Type != JTokenType.Object) + return null; + + currentToken = (currentToken.First as JProperty)?.Name; + } + + if (currentToken == null) + return null; + } + + return currentToken; + } + } +} diff --git a/CryptoExchange.Net/Sockets/MessageParsing/JsonNetSerializer.cs b/CryptoExchange.Net/Sockets/MessageParsing/JsonNetSerializer.cs new file mode 100644 index 0000000..f501cd8 --- /dev/null +++ b/CryptoExchange.Net/Sockets/MessageParsing/JsonNetSerializer.cs @@ -0,0 +1,12 @@ +using CryptoExchange.Net.Sockets.MessageParsing.Interfaces; +using Newtonsoft.Json; + +namespace CryptoExchange.Net.Sockets.MessageParsing +{ + /// + public class JsonNetSerializer : IMessageSerializer + { + /// + public string Serialize(object message) => JsonConvert.SerializeObject(message, Formatting.None); + } +} diff --git a/CryptoExchange.Net/Sockets/MessageParsing/MessageNode.cs b/CryptoExchange.Net/Sockets/MessageParsing/MessageNode.cs new file mode 100644 index 0000000..ecbc00a --- /dev/null +++ b/CryptoExchange.Net/Sockets/MessageParsing/MessageNode.cs @@ -0,0 +1,44 @@ +namespace CryptoExchange.Net.Sockets.MessageParsing +{ + /// + /// Node accessor + /// + public struct NodeAccessor + { + /// + /// Value + /// + public object? Value { get; } + /// + /// Type (0 = int, 1 = string, 2 = prop name) + /// + public int Type { get; } + + private NodeAccessor(object? value, int type) + { + Value = value; + Type = type; + } + + /// + /// Create an int node accessor + /// + /// + /// + public static NodeAccessor Int(int value) { return new NodeAccessor(value, 0); } + + /// + /// Create a string node accessor + /// + /// + /// + public static NodeAccessor String(string value) { return new NodeAccessor(value, 1); } + + /// + /// Create a property name node accessor + /// + /// + public static NodeAccessor PropertyName() { return new NodeAccessor(null, 2); } + } + +} diff --git a/CryptoExchange.Net/Sockets/MessageParsing/MessagePath.cs b/CryptoExchange.Net/Sockets/MessageParsing/MessagePath.cs new file mode 100644 index 0000000..51db132 --- /dev/null +++ b/CryptoExchange.Net/Sockets/MessageParsing/MessagePath.cs @@ -0,0 +1,50 @@ +using System.Collections; +using System.Collections.Generic; + +namespace CryptoExchange.Net.Sockets.MessageParsing +{ + /// + /// Message access definition + /// + public struct MessagePath : IEnumerable + { + private List _path; + + internal void Add(NodeAccessor node) + { + _path.Add(node); + } + + /// + /// ctor + /// + public MessagePath() + { + _path = new List(); + } + + /// + /// Create a new message path + /// + /// + public static MessagePath Get() + { + return new MessagePath(); + } + + /// + /// IEnumerable implementation + /// + /// + public IEnumerator GetEnumerator() + { + for (var i = 0; i < _path.Count; i++) + yield return _path[i]; + } + + IEnumerator IEnumerable.GetEnumerator() + { + return GetEnumerator(); + } + } +} diff --git a/CryptoExchange.Net/Sockets/MessageParsing/MessagePathExtension.cs b/CryptoExchange.Net/Sockets/MessageParsing/MessagePathExtension.cs new file mode 100644 index 0000000..771a992 --- /dev/null +++ b/CryptoExchange.Net/Sockets/MessageParsing/MessagePathExtension.cs @@ -0,0 +1,43 @@ +namespace CryptoExchange.Net.Sockets.MessageParsing +{ + /// + /// Message path extension methods + /// + public static class MessagePathExtension + { + /// + /// Add a string node accessor + /// + /// + /// + /// + public static MessagePath Property(this MessagePath path, string propName) + { + path.Add(NodeAccessor.String(propName)); + return path; + } + + /// + /// Add a property name node accessor + /// + /// + /// + public static MessagePath PropertyName(this MessagePath path) + { + path.Add(NodeAccessor.PropertyName()); + return path; + } + + /// + /// Add a int node accessor + /// + /// + /// + /// + public static MessagePath Index(this MessagePath path, int index) + { + path.Add(NodeAccessor.Int(index)); + return path; + } + } +} diff --git a/CryptoExchange.Net/Sockets/MessageParsing/NodeType.cs b/CryptoExchange.Net/Sockets/MessageParsing/NodeType.cs new file mode 100644 index 0000000..309db88 --- /dev/null +++ b/CryptoExchange.Net/Sockets/MessageParsing/NodeType.cs @@ -0,0 +1,21 @@ +namespace CryptoExchange.Net.Sockets.MessageParsing +{ + /// + /// Message node type + /// + public enum NodeType + { + /// + /// Array node + /// + Array, + /// + /// Object node + /// + Object, + /// + /// Value node + /// + Value + } +} diff --git a/CryptoExchange.Net/Sockets/PendingRequest.cs b/CryptoExchange.Net/Sockets/PendingRequest.cs deleted file mode 100644 index 6043d22..0000000 --- a/CryptoExchange.Net/Sockets/PendingRequest.cs +++ /dev/null @@ -1,57 +0,0 @@ -using CryptoExchange.Net.Objects; -using Newtonsoft.Json.Linq; -using System; -using System.Threading; - -namespace CryptoExchange.Net.Sockets -{ - internal class PendingRequest - { - public int Id { get; set; } - public Func Handler { get; } - public JToken? Result { get; private set; } - public bool Completed { get; private set; } - public AsyncResetEvent Event { get; } - public DateTime RequestTimestamp { get; set; } - public TimeSpan Timeout { get; } - public SocketSubscription? Subscription { get; } - - private CancellationTokenSource? _cts; - - public PendingRequest(int id, Func handler, TimeSpan timeout, SocketSubscription? subscription) - { - Id = id; - Handler = handler; - Event = new AsyncResetEvent(false, false); - Timeout = timeout; - RequestTimestamp = DateTime.UtcNow; - Subscription = subscription; - } - - public void IsSend() - { - // Start timeout countdown - _cts = new CancellationTokenSource(Timeout); - _cts.Token.Register(Fail, false); - } - - public bool CheckData(JToken data) - { - return Handler(data); - } - - public bool Succeed(JToken data) - { - Result = data; - Completed = true; - Event.Set(); - return true; - } - - public void Fail() - { - Completed = true; - Event.Set(); - } - } -} diff --git a/CryptoExchange.Net/Sockets/PeriodicTaskRegistration.cs b/CryptoExchange.Net/Sockets/PeriodicTaskRegistration.cs new file mode 100644 index 0000000..df80830 --- /dev/null +++ b/CryptoExchange.Net/Sockets/PeriodicTaskRegistration.cs @@ -0,0 +1,30 @@ +using CryptoExchange.Net.Objects; +using System; +using System.Collections.Generic; +using System.Text; + +namespace CryptoExchange.Net.Sockets +{ + /// + /// Periodic task registration + /// + public class PeriodicTaskRegistration + { + /// + /// Identifier + /// + public string Identifier { get; set; } = string.Empty; + /// + /// Interval of query + /// + public TimeSpan Interval { get; set; } + /// + /// Delegate for getting the query + /// + public Func QueryDelegate { get; set; } = null!; + /// + /// Callback after query + /// + public Action? Callback { get; set; } + } +} diff --git a/CryptoExchange.Net/Sockets/Query.cs b/CryptoExchange.Net/Sockets/Query.cs new file mode 100644 index 0000000..56d3ea4 --- /dev/null +++ b/CryptoExchange.Net/Sockets/Query.cs @@ -0,0 +1,206 @@ +using CryptoExchange.Net.Interfaces; +using CryptoExchange.Net.Objects; +using CryptoExchange.Net.Objects.Sockets; +using CryptoExchange.Net.Sockets.MessageParsing.Interfaces; +using System; +using System.Collections.Generic; +using System.Diagnostics; +using System.Threading; +using System.Threading.Tasks; + +namespace CryptoExchange.Net.Sockets +{ + /// + /// Query + /// + public abstract class Query : IMessageProcessor + { + /// + /// Unique identifier + /// + public int Id { get; } = ExchangeHelpers.NextId(); + + /// + /// Has this query been completed + /// + public bool Completed { get; set; } + + /// + /// Timestamp of when the request was send + /// + public DateTime RequestTimestamp { get; set; } + + /// + /// Result + /// + public CallResult? Result { get; set; } + + /// + /// Response + /// + public object? Response { get; set; } + + /// + /// Wait event for the calling message processing thread + /// + public AsyncResetEvent? ContinueAwaiter { get; set; } + + /// + /// Strings to match this query to a received message + /// + public abstract HashSet ListenerIdentifiers { get; set; } + + /// + /// The query request object + /// + public object Request { get; set; } + + /// + /// If this is a private request + /// + public bool Authenticated { get; } + + /// + /// Weight of the query + /// + public int Weight { get; } + + /// + /// Get the type the message should be deserialized to + /// + /// + /// + public abstract Type? GetMessageType(IMessageAccessor message); + + /// + /// Wait event for response + /// + protected AsyncResetEvent _event; + + /// + /// Cancellation token + /// + protected CancellationTokenSource? _cts; + + /// + /// ctor + /// + /// + /// + /// + public Query(object request, bool authenticated, int weight = 1) + { + _event = new AsyncResetEvent(false, false); + + Authenticated = authenticated; + Request = request; + Weight = weight; + } + + /// + /// Signal that the request has been send and the timeout timer should start + /// + public void IsSend(TimeSpan timeout) + { + // Start timeout countdown + RequestTimestamp = DateTime.UtcNow; + _cts = new CancellationTokenSource(timeout); + _cts.Token.Register(Timeout, false); + } + + /// + /// Wait untill timeout or the request is competed + /// + /// + /// + public async Task WaitAsync(TimeSpan timeout) => await _event.WaitAsync(timeout).ConfigureAwait(false); + + /// + public virtual object Deserialize(IMessageAccessor message, Type type) => message.Deserialize(type); + + /// + /// Mark request as timeout + /// + public abstract void Timeout(); + + /// + /// Mark request as failed + /// + /// + public abstract void Fail(string error); + + /// + /// Handle a response message + /// + /// + /// + /// + public abstract Task HandleAsync(SocketConnection connection, DataEvent message); + + } + + /// + /// Query + /// + /// Response object type + public abstract class Query : Query + { + /// + public override Type? GetMessageType(IMessageAccessor message) => typeof(TResponse); + + /// + /// The typed call result + /// + public CallResult? TypedResult => (CallResult?)Result; + + /// + /// ctor + /// + /// + /// + /// + protected Query(object request, bool authenticated, int weight = 1) : base(request, authenticated, weight) + { + } + + /// + public override async Task HandleAsync(SocketConnection connection, DataEvent message) + { + Completed = true; + Response = message.Data; + Result = await HandleMessageAsync(connection, message.As((TResponse)message.Data)).ConfigureAwait(false); + _event.Set(); + await (ContinueAwaiter?.WaitAsync() ?? Task.CompletedTask).ConfigureAwait(false); + return Result; + } + + /// + /// Handle the query response + /// + /// + /// + /// + public virtual Task> HandleMessageAsync(SocketConnection connection, DataEvent message) => Task.FromResult(new CallResult(message.Data, message.OriginalData, null)); + + /// + public override void Timeout() + { + if (Completed) + return; + + Completed = true; + Result = new CallResult(new CancellationRequestedError(null, "Query timeout", null)); + ContinueAwaiter?.Set(); + _event.Set(); + } + + /// + public override void Fail(string error) + { + Result = new CallResult(new ServerError(error)); + Completed = true; + ContinueAwaiter?.Set(); + _event.Set(); + } + } +} diff --git a/CryptoExchange.Net/Sockets/SocketConnection.cs b/CryptoExchange.Net/Sockets/SocketConnection.cs index 49f6917..0295d89 100644 --- a/CryptoExchange.Net/Sockets/SocketConnection.cs +++ b/CryptoExchange.Net/Sockets/SocketConnection.cs @@ -1,14 +1,17 @@ using CryptoExchange.Net.Interfaces; using System; using System.Collections.Generic; -using System.Diagnostics; using System.Linq; using System.Threading.Tasks; -using Newtonsoft.Json; -using Newtonsoft.Json.Linq; using Microsoft.Extensions.Logging; using CryptoExchange.Net.Objects; using System.Net.WebSockets; +using System.IO; +using CryptoExchange.Net.Objects.Sockets; +using System.Text; +using System.Diagnostics; +using CryptoExchange.Net.Sockets.MessageParsing; +using CryptoExchange.Net.Sockets.MessageParsing.Interfaces; namespace CryptoExchange.Net.Sockets { @@ -45,33 +48,36 @@ namespace CryptoExchange.Net.Sockets /// /// Unhandled message event /// - public event Action? UnhandledMessage; + public event Action? UnhandledMessage; /// /// The amount of subscriptions on this connection /// - public int SubscriptionCount - { - get { lock (_subscriptionLock) - return _subscriptions.Count(h => h.UserSubscription); } - } - - /// - /// Get a copy of the current subscriptions - /// - public SocketSubscription[] Subscriptions + public int UserSubscriptionCount { get { - lock (_subscriptionLock) - return _subscriptions.Where(h => h.UserSubscription).ToArray(); + lock(_listenersLock) + return _listeners.OfType().Count(h => h.UserSubscription); + } + } + + /// + /// Get a copy of the current message subscriptions + /// + public Subscription[] Subscriptions + { + get + { + lock(_listenersLock) + return _listeners.OfType().Where(h => h.UserSubscription).ToArray(); } } /// /// If the connection has been authenticated /// - public bool Authenticated { get; internal set; } + public bool Authenticated { get; set; } /// /// If connection is made @@ -124,7 +130,7 @@ namespace CryptoExchange.Net.Sockets if (_pausedActivity != value) { _pausedActivity = value; - _logger.Log(LogLevel.Information, $"Socket {SocketId} Paused activity: " + value); + _logger.Log(LogLevel.Information, $"[Sckt {SocketId}] paused activity: " + value); if(_pausedActivity) _ = Task.Run(() => ActivityPaused?.Invoke()); else _ = Task.Run(() => ActivityUnpaused?.Invoke()); } @@ -144,20 +150,29 @@ namespace CryptoExchange.Net.Sockets var oldStatus = _status; _status = value; - _logger.Log(LogLevel.Debug, $"Socket {SocketId} status changed from {oldStatus} to {_status}"); + _logger.Log(LogLevel.Debug, $"[Sckt {SocketId}] status changed from {oldStatus} to {_status}"); } } private bool _pausedActivity; - private readonly List _subscriptions; - private readonly object _subscriptionLock = new(); - + private readonly object _listenersLock; + private readonly List _listeners; private readonly ILogger _logger; - - private readonly List _pendingRequests; - private SocketStatus _status; + private IMessageSerializer _serializer; + private IMessageAccessor _accessor; + + /// + /// The task that is sending periodic data on the websocket. Can be used for sending Ping messages every x seconds or similair. Not necesarry. + /// + protected Task? periodicTask; + + /// + /// Wait event for the periodicTask + /// + protected AsyncResetEvent? periodicEvent; + /// /// The underlying websocket /// @@ -177,59 +192,80 @@ namespace CryptoExchange.Net.Sockets Tag = tag; Properties = new Dictionary(); - _pendingRequests = new List(); - _subscriptions = new List(); - _socket = socket; - _socket.OnMessage += HandleMessage; - _socket.OnRequestSent += HandleRequestSent; - _socket.OnOpen += HandleOpen; - _socket.OnClose += HandleClose; - _socket.OnReconnecting += HandleReconnecting; - _socket.OnReconnected += HandleReconnected; - _socket.OnError += HandleError; + _socket.OnStreamMessage += HandleStreamMessage; + _socket.OnRequestSent += HandleRequestSentAsync; + _socket.OnOpen += HandleOpenAsync; + _socket.OnClose += HandleCloseAsync; + _socket.OnReconnecting += HandleReconnectingAsync; + _socket.OnReconnected += HandleReconnectedAsync; + _socket.OnError += HandleErrorAsync; _socket.GetReconnectionUrl = GetReconnectionUrlAsync; + + _listenersLock = new object(); + _listeners = new List(); + + _serializer = new JsonNetSerializer(); + _accessor = new JsonNetMessageAccessor(); } /// /// Handler for a socket opening /// - protected virtual void HandleOpen() + protected virtual Task HandleOpenAsync() { Status = SocketStatus.Connected; PausedActivity = false; + return Task.CompletedTask; } /// /// Handler for a socket closing without reconnect /// - protected virtual void HandleClose() + protected virtual Task HandleCloseAsync() { Status = SocketStatus.Closed; Authenticated = false; - lock(_subscriptionLock) + + lock (_listenersLock) { - foreach (var sub in _subscriptions) - sub.Confirmed = false; - } - Task.Run(() => ConnectionClosed?.Invoke()); + foreach (var subscription in _listeners.OfType()) + subscription.Confirmed = false; + + foreach (var query in _listeners.OfType().ToList()) + { + query.Fail("Connection interupted"); + _listeners.Remove(query); + } + } + + _ = Task.Run(() => ConnectionClosed?.Invoke()); + return Task.CompletedTask; } /// - /// Handler for a socket losing conenction and starting reconnect + /// Handler for a socket losing connection and starting reconnect /// - protected virtual void HandleReconnecting() + protected virtual Task HandleReconnectingAsync() { Status = SocketStatus.Reconnecting; DisconnectTime = DateTime.UtcNow; Authenticated = false; - lock (_subscriptionLock) + + lock (_listenersLock) { - foreach (var sub in _subscriptions) - sub.Confirmed = false; + foreach (var subscription in _listeners.OfType()) + subscription.Confirmed = false; + + foreach (var query in _listeners.OfType().ToList()) + { + query.Fail("Connection interupted"); + _listeners.Remove(query); + } } _ = Task.Run(() => ConnectionLost?.Invoke()); + return Task.CompletedTask; } /// @@ -244,146 +280,195 @@ namespace CryptoExchange.Net.Sockets /// /// Handler for a socket which has reconnected /// - protected virtual async void HandleReconnected() + protected virtual Task HandleReconnectedAsync() { Status = SocketStatus.Resubscribing; - lock (_pendingRequests) + + lock (_listenersLock) { - foreach (var pendingRequest in _pendingRequests.ToList()) + foreach (var query in _listeners.OfType().ToList()) { - pendingRequest.Fail(); - _pendingRequests.Remove(pendingRequest); + query.Fail("Connection interupted"); + _listeners.Remove(query); } } - var reconnectSuccessful = await ProcessReconnectAsync().ConfigureAwait(false); - if (!reconnectSuccessful) + // Can't wait for this as it would cause a deadlock + _ = Task.Run(async () => { - _logger.Log(LogLevel.Warning, $"Socket {SocketId} Failed reconnect processing: {reconnectSuccessful.Error}, reconnecting again"); - await _socket.ReconnectAsync().ConfigureAwait(false); - } - else - { - Status = SocketStatus.Connected; - _ = Task.Run(() => + try { - ConnectionRestored?.Invoke(DateTime.UtcNow - DisconnectTime!.Value); - DisconnectTime = null; - }); - } + var reconnectSuccessful = await ProcessReconnectAsync().ConfigureAwait(false); + if (!reconnectSuccessful) + { + _logger.Log(LogLevel.Warning, $"[Sckt {SocketId}] failed reconnect processing: {reconnectSuccessful.Error}, reconnecting again"); + _ = _socket.ReconnectAsync().ConfigureAwait(false); + } + else + { + Status = SocketStatus.Connected; + _ = Task.Run(() => + { + ConnectionRestored?.Invoke(DateTime.UtcNow - DisconnectTime!.Value); + DisconnectTime = null; + }); + } + } + catch(Exception ex) + { + _logger.Log(LogLevel.Warning, ex, $"[Sckt {SocketId}] Unknown exception while processing reconnection, reconnecting again"); + _ = _socket.ReconnectAsync().ConfigureAwait(false); + } + }); + + return Task.CompletedTask; } /// /// Handler for an error on a websocket /// /// The exception - protected virtual void HandleError(Exception e) + protected virtual Task HandleErrorAsync(Exception e) { if (e is WebSocketException wse) - _logger.Log(LogLevel.Warning, $"Socket {SocketId} error: Websocket error code {wse.WebSocketErrorCode}, details: " + e.ToLogString()); + _logger.Log(LogLevel.Warning, $"[Sckt {SocketId}] error: Websocket error code {wse.WebSocketErrorCode}, details: " + e.ToLogString()); else - _logger.Log(LogLevel.Warning, $"Socket {SocketId} error: " + e.ToLogString()); + _logger.Log(LogLevel.Warning, $"[Sckt {SocketId}] error: " + e.ToLogString()); + + return Task.CompletedTask; } /// /// Handler for whenever a request is sent over the websocket /// /// Id of the request sent - protected virtual void HandleRequestSent(int requestId) + protected virtual Task HandleRequestSentAsync(int requestId) { - PendingRequest pendingRequest; - lock (_pendingRequests) - pendingRequest = _pendingRequests.SingleOrDefault(p => p.Id == requestId); - - if (pendingRequest == null) + Query query; + lock (_listenersLock) { - _logger.Log(LogLevel.Debug, $"Socket {SocketId} - msg {requestId} - message sent, but not pending"); - return; + query = _listeners.OfType().FirstOrDefault(x => x.Id == requestId); } - pendingRequest.IsSend(); + if (query == null) + { + _logger.Log(LogLevel.Debug, $"[Sckt {SocketId}] msg {requestId} - message sent, but not pending"); + return Task.CompletedTask; + } + + query.IsSend(ApiClient.ClientOptions.RequestTimeout); + return Task.CompletedTask; } /// - /// Process a message received by the socket + /// Handle a message /// - /// The received data - protected virtual void HandleMessage(string data) + /// + /// + /// + protected virtual async Task HandleStreamMessage(WebSocketMessageType type, Stream stream) { - var timestamp = DateTime.UtcNow; - _logger.Log(LogLevel.Trace, $"Socket {SocketId} received data: " + data); - if (string.IsNullOrEmpty(data)) return; + var sw = Stopwatch.StartNew(); + var receiveTime = DateTime.UtcNow; + string? originalData = null; - var tokenData = data.ToJToken(_logger); - if (tokenData == null) + // 1. Decrypt/Preprocess if necessary + stream = ApiClient.PreprocessStreamMessage(type, stream); + + // 2. Read data into accessor + _accessor.Load(stream); + if (ApiClient.ApiOptions.OutputOriginalData ?? ApiClient.ClientOptions.OutputOriginalData) { - data = $"\"{data}\""; - tokenData = data.ToJToken(_logger); - if (tokenData == null) - return; + stream.Position = 0; + using var textReader = new StreamReader(stream, Encoding.UTF8, false, 1024, true); + originalData = textReader.ReadToEnd(); + + _logger.LogTrace("[Sckt {SocketId}] received {Data}", SocketId, originalData); } - var handledResponse = false; - - // Remove any timed out requests - PendingRequest[] requests; - lock (_pendingRequests) + // 3. Determine the identifying properties of this message + var listenId = ApiClient.GetListenerIdentifier(_accessor); + if (listenId == null) { - // Remove only timed out requests after 5 minutes have passed so we can still process any - // message coming in after the request timeout - _pendingRequests.RemoveAll(r => r.Completed && DateTime.UtcNow - r.RequestTimestamp > TimeSpan.FromMinutes(5)); - requests = _pendingRequests.ToArray(); + if (!ApiClient.UnhandledMessageExpected) + _logger.LogWarning("[Sckt {SocketId}] failed to evaluate message", SocketId); + + UnhandledMessage?.Invoke(_accessor); + stream.Dispose(); + return; } - // Check if this message is an answer on any pending requests - foreach (var pendingRequest in requests) + // 4. Get the listeners interested in this message + List processors; + lock(_listenersLock) + processors = _listeners.Where(s => s.ListenerIdentifiers.Contains(listenId)).ToList(); + + if (!processors.Any()) { - if (pendingRequest.CheckData(tokenData)) + if (!ApiClient.UnhandledMessageExpected) { - lock (_pendingRequests) - _pendingRequests.Remove(pendingRequest); + _logger.LogWarning("[Sckt {SocketId}] received message not matched to any listener. ListenId: {ListenId}", SocketId, listenId); + UnhandledMessage?.Invoke(_accessor); + } - if (pendingRequest.Completed) + stream.Dispose(); + return; + } + + _logger.LogTrace("[Sckt {SocketId}] {Count} processor(s) matched to message with listener identifier {ListenerId}", SocketId, processors.Count, listenId); + var totalUserTime = 0; + Dictionary? desCache = null; + if (processors.Count > 1) + { + // Only instantiate a cache if there are multiple processors + desCache = new Dictionary(); + } + + foreach (var processor in processors) + { + // 5. Determine the type to deserialize to for this processor + var messageType = processor.GetMessageType(_accessor); + if (messageType == null) + { + _logger.LogWarning("[Sckt {SocketId}] received message not recognized by handler {Id}", SocketId, processor.Id); + continue; + } + + // 6. Deserialize the message + object? deserialized = null; + desCache?.TryGetValue(messageType, out deserialized); + + if (deserialized == null) + { + try { - // Answer to a timed out request, unsub if it is a subscription request - if (pendingRequest.Subscription != null) - { - _logger.Log(LogLevel.Warning, $"Socket {SocketId} Received subscription info after request timed out; unsubscribing. Consider increasing the RequestTimeout"); - _ = ApiClient.UnsubscribeAsync(this, pendingRequest.Subscription).ConfigureAwait(false); - } + deserialized = processor.Deserialize(_accessor, messageType); + desCache?.Add(messageType, deserialized); } - else + catch (Exception ex) { - _logger.Log(LogLevel.Trace, $"Socket {SocketId} - msg {pendingRequest.Id} - received data matched to pending request"); - pendingRequest.Succeed(tokenData); + _logger.LogWarning("[Sckt {SocketId}] failed to deserialize message to type {Type}: {Exception}", SocketId, messageType.Name, ex.ToLogString()); + continue; } + } - if (!ApiClient.ContinueOnQueryResponse) - return; - - handledResponse = true; - break; + // 7. Hand of the message to the subscription + try + { + var innerSw = Stopwatch.StartNew(); + await processor.HandleAsync(this, new DataEvent(deserialized, null, originalData, receiveTime, null)).ConfigureAwait(false); + totalUserTime += (int)innerSw.ElapsedMilliseconds; + } + catch (Exception ex) + { + _logger.LogWarning("[Sckt {SocketId}] user message processing failed: {Exception}", SocketId, ex.ToLogString()); + if (processor is Subscription subscription) + subscription.InvokeExceptionHandler(ex); } } - // Message was not a request response, check data handlers - var messageEvent = new MessageEvent(this, tokenData, ApiClient.OutputOriginalData ? data : null, timestamp); - var (handled, userProcessTime, subscription) = HandleData(messageEvent); - if (!handled && !handledResponse) - { - if (!ApiClient.UnhandledMessageExpected) - _logger.Log(LogLevel.Warning, $"Socket {SocketId} Message not handled: " + tokenData); - UnhandledMessage?.Invoke(tokenData); - } - - var total = DateTime.UtcNow - timestamp; - if (userProcessTime.TotalMilliseconds > 500) - { - _logger.Log(LogLevel.Debug, $"Socket {SocketId}{(subscription == null ? "" : " subscription " + subscription!.Id)} message processing slow ({(int)total.TotalMilliseconds}ms, {(int)userProcessTime.TotalMilliseconds}ms user code), consider offloading data handling to another thread. " + - "Data from this socket may arrive late or not at all if message processing is continuously slow."); - } - - _logger.Log(LogLevel.Trace, $"Socket {SocketId}{(subscription == null ? "" : " subscription " + subscription!.Id)} message processed in {(int)total.TotalMilliseconds}ms ({(int)userProcessTime.TotalMilliseconds}ms user code)"); + stream.Dispose(); + _logger.LogTrace($"[Sckt {SocketId}] message processed in {(int)sw.ElapsedMilliseconds}ms ({sw.ElapsedMilliseconds - totalUserTime}ms parsing)"); } /// @@ -416,9 +501,9 @@ namespace CryptoExchange.Net.Sockets if (ApiClient.socketConnections.ContainsKey(SocketId)) ApiClient.socketConnections.TryRemove(SocketId, out _); - lock (_subscriptionLock) + lock (_listenersLock) { - foreach (var subscription in _subscriptions) + foreach (var subscription in _listeners.OfType()) { if (subscription.CancellationTokenRegistration.HasValue) subscription.CancellationTokenRegistration.Value.Dispose(); @@ -433,49 +518,59 @@ namespace CryptoExchange.Net.Sockets /// Close a subscription on this connection. If all subscriptions on this connection are closed the connection gets closed as well /// /// Subscription to close + /// Whether to send an unsub request even if the subscription wasn't confirmed /// - public async Task CloseAsync(SocketSubscription subscription) + public async Task CloseAsync(Subscription subscription, bool unsubEvenIfNotConfirmed = false) { - lock (_subscriptionLock) - { - if (!_subscriptions.Contains(subscription)) - return; - - subscription.Closed = true; - } + subscription.Closed = true; if (Status == SocketStatus.Closing || Status == SocketStatus.Closed || Status == SocketStatus.Disposed) return; - _logger.Log(LogLevel.Debug, $"Socket {SocketId} closing subscription {subscription.Id}"); + _logger.Log(LogLevel.Debug, $"[Sckt {SocketId}] closing subscription {subscription.Id}"); if (subscription.CancellationTokenRegistration.HasValue) subscription.CancellationTokenRegistration.Value.Dispose(); - if (subscription.Confirmed && _socket.IsOpen) - await ApiClient.UnsubscribeAsync(this, subscription).ConfigureAwait(false); + bool anyDuplicateSubscription; + lock (_listenersLock) + anyDuplicateSubscription = _listeners.OfType().Any(x => x != subscription && x.ListenerIdentifiers.All(l => subscription.ListenerIdentifiers.Contains(l))); + + if (!anyDuplicateSubscription) + { + bool needUnsub; + lock (_listenersLock) + needUnsub = _listeners.Contains(subscription); + + if (needUnsub && (unsubEvenIfNotConfirmed || subscription.Confirmed) && _socket.IsOpen) + await UnsubscribeAsync(subscription).ConfigureAwait(false); + } + else + { + _logger.Log(LogLevel.Debug, $"[Sckt {SocketId}] not unsubscribing subscription as there is still a duplicate subscription running"); + } + + if (Status == SocketStatus.Closing) + { + _logger.Log(LogLevel.Debug, $"[Sckt {SocketId}] already closing"); + return; + } bool shouldCloseConnection; - lock (_subscriptionLock) + lock (_listenersLock) { - if (Status == SocketStatus.Closing) - { - _logger.Log(LogLevel.Debug, $"Socket {SocketId} already closing"); - return; - } - - shouldCloseConnection = _subscriptions.All(r => !r.UserSubscription || r.Closed); + shouldCloseConnection = _listeners.OfType().All(r => !r.UserSubscription || r.Closed); if (shouldCloseConnection) Status = SocketStatus.Closing; } if (shouldCloseConnection) { - _logger.Log(LogLevel.Debug, $"Socket {SocketId} closing as there are no more subscriptions"); + _logger.Log(LogLevel.Debug, $"[Sckt {SocketId}] closing as there are no more subscriptions"); await CloseAsync().ConfigureAwait(false); } - lock (_subscriptionLock) - _subscriptions.Remove(subscription); + lock (_listenersLock) + _listeners.Remove(subscription); } /// @@ -484,144 +579,107 @@ namespace CryptoExchange.Net.Sockets public void Dispose() { Status = SocketStatus.Disposed; + periodicEvent?.Set(); + periodicEvent?.Dispose(); _socket.Dispose(); } + /// + /// Whether or not a new subscription can be added to this connection + /// + /// + public bool CanAddSubscription() => Status == SocketStatus.None || Status == SocketStatus.Connected; + /// /// Add a subscription to this connection /// /// - public bool AddSubscription(SocketSubscription subscription) + public bool AddSubscription(Subscription subscription) { - lock (_subscriptionLock) - { - if (Status != SocketStatus.None && Status != SocketStatus.Connected) - return false; + if (Status != SocketStatus.None && Status != SocketStatus.Connected) + return false; - _subscriptions.Add(subscription); - if(subscription.UserSubscription) - _logger.Log(LogLevel.Debug, $"Socket {SocketId} adding new subscription with id {subscription.Id}, total subscriptions on connection: {_subscriptions.Count(s => s.UserSubscription)}"); - return true; - } + lock (_listenersLock) + _listeners.Add(subscription); + + if (subscription.UserSubscription) + _logger.Log(LogLevel.Debug, $"[Sckt {SocketId}] adding new subscription with id {subscription.Id}, total subscriptions on connection: {UserSubscriptionCount}"); + return true; } /// /// Get a subscription on this connection by id /// /// - public SocketSubscription? GetSubscription(int id) + public Subscription? GetSubscription(int id) { - lock (_subscriptionLock) - return _subscriptions.SingleOrDefault(s => s.Id == id); + lock (_listenersLock) + return _listeners.OfType().SingleOrDefault(s => s.Id == id); } /// - /// Get a subscription on this connection by its subscribe request + /// Send a query request and wait for an answer /// - /// Filter for a request + /// Query to send + /// Wait event for when the socket message handler can continue /// - public SocketSubscription? GetSubscriptionByRequest(Func predicate) + public virtual async Task SendAndWaitQueryAsync(Query query, AsyncResetEvent? continueEvent = null) { - lock(_subscriptionLock) - return _subscriptions.SingleOrDefault(s => predicate(s.Request)); + await SendAndWaitIntAsync(query, continueEvent).ConfigureAwait(false); + return query.Result ?? new CallResult(new ServerError("Timeout")); } /// - /// Process data + /// Send a query request and wait for an answer /// - /// - /// True if the data was successfully handled - private (bool, TimeSpan, SocketSubscription?) HandleData(MessageEvent messageEvent) - { - SocketSubscription? currentSubscription = null; - try - { - var handled = false; - TimeSpan userCodeDuration = TimeSpan.Zero; - - // Loop the subscriptions to check if any of them signal us that the message is for them - List subscriptionsCopy; - lock (_subscriptionLock) - subscriptionsCopy = _subscriptions.ToList(); - - foreach (var subscription in subscriptionsCopy) - { - currentSubscription = subscription; - if (subscription.Request == null) - { - if (ApiClient.MessageMatchesHandler(this, messageEvent.JsonData, subscription.Identifier!)) - { - handled = true; - var userSw = Stopwatch.StartNew(); - subscription.MessageHandler(messageEvent); - userSw.Stop(); - userCodeDuration = userSw.Elapsed; - } - } - else - { - if (ApiClient.MessageMatchesHandler(this, messageEvent.JsonData, subscription.Request)) - { - handled = true; - messageEvent.JsonData = ApiClient.ProcessTokenData(messageEvent.JsonData); - var userSw = Stopwatch.StartNew(); - subscription.MessageHandler(messageEvent); - userSw.Stop(); - userCodeDuration = userSw.Elapsed; - } - } - } - - return (handled, userCodeDuration, currentSubscription); - } - catch (Exception ex) - { - _logger.Log(LogLevel.Error, $"Socket {SocketId} Exception during message processing\r\nException: {ex.ToLogString()}\r\nData: {messageEvent.JsonData}"); - currentSubscription?.InvokeExceptionHandler(ex); - return (false, TimeSpan.Zero, null); - } - } - - /// - /// Send data and wait for an answer - /// - /// The data type expected in response - /// The object to send - /// The timeout for response - /// Subscription if this is a subscribe request - /// The response handler, should return true if the received JToken was the response to the request - /// The weight of the message + /// Query response type + /// Query to send + /// Wait event for when the socket message handler can continue /// - public virtual async Task SendAndWaitAsync(T obj, TimeSpan timeout, SocketSubscription? subscription, int weight, Func handler) + public virtual async Task> SendAndWaitQueryAsync(Query query, AsyncResetEvent? continueEvent = null) { - var pending = new PendingRequest(ExchangeHelpers.NextId(), handler, timeout, subscription); - lock (_pendingRequests) - { - _pendingRequests.Add(pending); - } + await SendAndWaitIntAsync(query, continueEvent).ConfigureAwait(false); + return query.TypedResult ?? new CallResult(new ServerError("Timeout")); + } - var sendOk = Send(pending.Id, obj, weight); + private async Task SendAndWaitIntAsync(Query query, AsyncResetEvent? continueEvent) + { + lock(_listenersLock) + _listeners.Add(query); + + query.ContinueAwaiter = continueEvent; + var sendOk = Send(query.Id, query.Request, query.Weight); if (!sendOk) { - pending.Fail(); + query.Fail("Failed to send"); + lock (_listenersLock) + _listeners.Remove(query); return; } - while (true) + try { - if(!_socket.IsOpen) + while (true) { - pending.Fail(); - return; + if (!_socket.IsOpen) + { + query.Fail("Socket not open"); + return; + } + + if (query.Completed) + return; + + await query.WaitAsync(TimeSpan.FromMilliseconds(500)).ConfigureAwait(false); + + if (query.Completed) + return; } - - if (pending.Completed) - return; - - await pending.Event.WaitAsync(TimeSpan.FromMilliseconds(500)).ConfigureAwait(false); - - if (pending.Completed) - return; + } + finally + { + lock (_listenersLock) + _listeners.Remove(query); } } @@ -631,14 +689,13 @@ namespace CryptoExchange.Net.Sockets /// The type of the object to send /// The request id /// The object to send - /// How null values should be serialized /// The weight of the message - public virtual bool Send(int requestId, T obj, int weight, NullValueHandling nullValueHandling = NullValueHandling.Ignore) + public virtual bool Send(int requestId, T obj, int weight) { if(obj is string str) return Send(requestId, str, weight); else - return Send(requestId, JsonConvert.SerializeObject(obj, Formatting.None, new JsonSerializerSettings { NullValueHandling = nullValueHandling }), weight); + return Send(requestId, _serializer.Serialize(obj!), weight); } /// @@ -649,7 +706,7 @@ namespace CryptoExchange.Net.Sockets /// The id of the request public virtual bool Send(int requestId, string data, int weight) { - _logger.Log(LogLevel.Trace, $"Socket {SocketId} - msg {requestId} - sending messsage: {data}"); + _logger.Log(LogLevel.Trace, $"[Sckt {SocketId}] msg {requestId} - sending messsage: {data}"); try { _socket.Send(requestId, data, weight); @@ -661,100 +718,163 @@ namespace CryptoExchange.Net.Sockets } } - private async Task> ProcessReconnectAsync() + private async Task ProcessReconnectAsync() { if (!_socket.IsOpen) return new CallResult(new WebError("Socket not connected")); - bool anySubscriptions = false; - lock (_subscriptionLock) - anySubscriptions = _subscriptions.Any(s => s.UserSubscription); - + bool anySubscriptions; + lock (_listenersLock) + anySubscriptions = _listeners.OfType().Any(s => s.UserSubscription); if (!anySubscriptions) { // No need to resubscribe anything - _logger.Log(LogLevel.Debug, $"Socket {SocketId} Nothing to resubscribe, closing connection"); + _logger.Log(LogLevel.Debug, $"[Sckt {SocketId}] nothing to resubscribe, closing connection"); _ = _socket.CloseAsync(); return new CallResult(true); } - bool anyAuthenticated = false; - lock (_subscriptionLock) - anyAuthenticated = _subscriptions.Any(s => s.Authenticated); - + bool anyAuthenticated; + lock (_listenersLock) + anyAuthenticated = _listeners.OfType().Any(s => s.Authenticated); if (anyAuthenticated) { // If we reconnected a authenticated connection we need to re-authenticate var authResult = await ApiClient.AuthenticateSocketAsync(this).ConfigureAwait(false); if (!authResult) { - _logger.Log(LogLevel.Warning, $"Socket {SocketId} authentication failed on reconnected socket. Disconnecting and reconnecting."); + _logger.Log(LogLevel.Warning, $"[Sckt {SocketId}] authentication failed on reconnected socket. Disconnecting and reconnecting."); return authResult; } Authenticated = true; - _logger.Log(LogLevel.Debug, $"Socket {SocketId} authentication succeeded on reconnected socket."); + _logger.Log(LogLevel.Debug, $"[Sckt {SocketId}] authentication succeeded on reconnected socket."); } // Get a list of all subscriptions on the socket - List subscriptionList = new List(); - lock (_subscriptionLock) - { - foreach (var subscription in _subscriptions) - { - if (subscription.Request != null) - subscriptionList.Add(subscription); - else - subscription.Confirmed = true; - } - } + List subList; + lock (_listenersLock) + subList = _listeners.OfType().ToList(); - foreach(var subscription in subscriptionList.Where(s => s.Request != null)) + foreach(var subscription in subList) { - var result = await ApiClient.RevitalizeRequestAsync(subscription.Request!).ConfigureAwait(false); + subscription.ConnectionInvocations = 0; + var result = await ApiClient.RevitalizeRequestAsync(subscription).ConfigureAwait(false); if (!result) { - _logger.Log(LogLevel.Warning, $"Socket {SocketId} Failed request revitalization: " + result.Error); - return result.As(false); + _logger.Log(LogLevel.Warning, $"[Sckt {SocketId}] failed request revitalization: " + result.Error); + return result; } } // Foreach subscription which is subscribed by a subscription request we will need to resend that request to resubscribe - for (var i = 0; i < subscriptionList.Count; i += ApiClient.ClientOptions.MaxConcurrentResubscriptionsPerSocket) + for (var i = 0; i < subList.Count; i += ApiClient.ClientOptions.MaxConcurrentResubscriptionsPerSocket) { if (!_socket.IsOpen) return new CallResult(new WebError("Socket not connected")); - var taskList = new List>>(); - foreach (var subscription in subscriptionList.Skip(i).Take(ApiClient.ClientOptions.MaxConcurrentResubscriptionsPerSocket)) - taskList.Add(ApiClient.SubscribeAndWaitAsync(this, subscription.Request!, subscription)); + var taskList = new List>(); + foreach (var subscription in subList.Skip(i).Take(ApiClient.ClientOptions.MaxConcurrentResubscriptionsPerSocket)) + { + var subQuery = subscription.GetSubQuery(this); + if (subQuery == null) + continue; + + var waitEvent = new AsyncResetEvent(false); + taskList.Add(SendAndWaitQueryAsync(subQuery, waitEvent).ContinueWith((r) => + { + subscription.HandleSubQueryResponse(subQuery.Response!); + waitEvent.Set(); + return r.Result; + })); + } await Task.WhenAll(taskList).ConfigureAwait(false); if (taskList.Any(t => !t.Result.Success)) return taskList.First(t => !t.Result.Success).Result; } - foreach (var subscription in subscriptionList) + foreach (var subscription in subList) subscription.Confirmed = true; if (!_socket.IsOpen) return new CallResult(new WebError("Socket not connected")); - _logger.Log(LogLevel.Debug, $"Socket {SocketId} all subscription successfully resubscribed on reconnected socket."); + _logger.Log(LogLevel.Debug, $"[Sckt {SocketId}] all subscription successfully resubscribed on reconnected socket."); return new CallResult(true); } - internal async Task UnsubscribeAsync(SocketSubscription socketSubscription) + internal async Task UnsubscribeAsync(Subscription subscription) { - await ApiClient.UnsubscribeAsync(this, socketSubscription).ConfigureAwait(false); + var unsubscribeRequest = subscription.GetUnsubQuery(); + if (unsubscribeRequest == null) + return; + + await SendAndWaitQueryAsync(unsubscribeRequest).ConfigureAwait(false); + _logger.Log(LogLevel.Information, $"[Sckt {SocketId}] subscription {subscription!.Id} unsubscribed"); } - internal async Task> ResubscribeAsync(SocketSubscription socketSubscription) + internal async Task ResubscribeAsync(Subscription subscription) { if (!_socket.IsOpen) - return new CallResult(new UnknownError("Socket is not connected")); + return new CallResult(new UnknownError("Socket is not connected")); - return await ApiClient.SubscribeAndWaitAsync(this, socketSubscription.Request!, socketSubscription).ConfigureAwait(false); + var subQuery = subscription.GetSubQuery(this); + if (subQuery == null) + return new CallResult(null); + + var result = await SendAndWaitQueryAsync(subQuery).ConfigureAwait(false); + subscription.HandleSubQueryResponse(subQuery.Response!); + return result; + } + + /// + /// Periodically sends data over a socket connection + /// + /// Identifier for the periodic send + /// How often + /// Method returning the query to send + /// The callback for processing the response + public virtual void QueryPeriodic(string identifier, TimeSpan interval, Func queryDelegate, Action? callback) + { + if (queryDelegate == null) + throw new ArgumentNullException(nameof(queryDelegate)); + + periodicEvent = new AsyncResetEvent(); + periodicTask = Task.Run(async () => + { + while (Status != SocketStatus.Disposed + && Status != SocketStatus.Closed + && Status != SocketStatus.Closing) + { + await periodicEvent.WaitAsync(interval).ConfigureAwait(false); + if (Status == SocketStatus.Disposed + || Status == SocketStatus.Closed + || Status == SocketStatus.Closing) + { + break; + } + + if (!Connected) + continue; + + var query = queryDelegate(this); + if (query == null) + continue; + + _logger.Log(LogLevel.Trace, $"[Sckt {SocketId}] sending periodic {identifier}"); + + try + { + var result = await SendAndWaitQueryAsync(query).ConfigureAwait(false); + callback?.Invoke(result); + } + catch (Exception ex) + { + _logger.Log(LogLevel.Warning, $"[Sckt {SocketId}] Periodic send {identifier} failed: " + ex.ToLogString()); + } + } + }); } /// @@ -793,3 +913,4 @@ namespace CryptoExchange.Net.Sockets } } } + diff --git a/CryptoExchange.Net/Sockets/SocketSubscription.cs b/CryptoExchange.Net/Sockets/SocketSubscription.cs deleted file mode 100644 index 62e7b87..0000000 --- a/CryptoExchange.Net/Sockets/SocketSubscription.cs +++ /dev/null @@ -1,111 +0,0 @@ -using System; -using System.Threading; - -namespace CryptoExchange.Net.Sockets -{ - /// - /// Socket subscription - /// - public class SocketSubscription - { - /// - /// Unique subscription id - /// - public int Id { get; } - - /// - /// Exception event - /// - public event Action? Exception; - - /// - /// Message handlers for this subscription. Should return true if the message is handled and should not be distributed to the other handlers - /// - public Action MessageHandler { get; set; } - - /// - /// The request object send when subscribing on the server. Either this or the `Identifier` property should be set - /// - public object? Request { get; set; } - - /// - /// The subscription identifier, used instead of a `Request` object to identify the subscription - /// - public string? Identifier { get; set; } - - /// - /// Whether this is a user subscription or an internal listener - /// - public bool UserSubscription { get; set; } - - /// - /// If the subscription has been confirmed to be subscribed by the server - /// - public bool Confirmed { get; set; } - - /// - /// Whether authentication is needed for this subscription - /// - public bool Authenticated { get; set; } - - /// - /// Whether we're closing this subscription and a socket connection shouldn't be kept open for it - /// - public bool Closed { get; set; } - - /// - /// Cancellation token registration, should be disposed when subscription is closed. Used for closing the subscription with - /// a provided cancelation token - /// - public CancellationTokenRegistration? CancellationTokenRegistration { get; set; } - - private SocketSubscription(int id, object? request, string? identifier, bool userSubscription, bool authenticated, Action dataHandler) - { - Id = id; - UserSubscription = userSubscription; - MessageHandler = dataHandler; - Request = request; - Identifier = identifier; - Authenticated = authenticated; - } - - /// - /// Create SocketSubscription for a subscribe request - /// - /// - /// - /// - /// - /// - /// - public static SocketSubscription CreateForRequest(int id, object request, bool userSubscription, - bool authenticated, Action dataHandler) - { - return new SocketSubscription(id, request, null, userSubscription, authenticated, dataHandler); - } - - /// - /// Create SocketSubscription for an identifier - /// - /// - /// - /// - /// - /// - /// - public static SocketSubscription CreateForIdentifier(int id, string identifier, bool userSubscription, - bool authenticated, Action dataHandler) - { - return new SocketSubscription(id, null, identifier, userSubscription, authenticated, dataHandler); - } - - /// - /// Invoke the exception event - /// - /// - public void InvokeExceptionHandler(Exception e) - { - Exception?.Invoke(e); - } - } -} diff --git a/CryptoExchange.Net/Sockets/Subscription.cs b/CryptoExchange.Net/Sockets/Subscription.cs new file mode 100644 index 0000000..353c9b7 --- /dev/null +++ b/CryptoExchange.Net/Sockets/Subscription.cs @@ -0,0 +1,185 @@ +using CryptoExchange.Net.Interfaces; +using CryptoExchange.Net.Objects; +using CryptoExchange.Net.Objects.Sockets; +using CryptoExchange.Net.Sockets.MessageParsing.Interfaces; +using Microsoft.Extensions.Logging; +using System; +using System.Collections.Generic; +using System.Threading; +using System.Threading.Tasks; + +namespace CryptoExchange.Net.Sockets +{ + /// + /// Socket subscription + /// + public abstract class Subscription : IMessageProcessor + { + /// + /// Subscription id + /// + public int Id { get; set; } + + /// + /// Total amount of invocations + /// + public int TotalInvocations { get; set; } + + /// + /// Amount of invocation during this connection + /// + public int ConnectionInvocations { get; set; } + + /// + /// Is it a user subscription + /// + public bool UserSubscription { get; set; } + + /// + /// Has the subscription been confirmed + /// + public bool Confirmed { get; set; } + + /// + /// Is the subscription closed + /// + public bool Closed { get; set; } + + /// + /// Logger + /// + protected readonly ILogger _logger; + + /// + /// If the subscription is a private subscription and needs authentication + /// + public bool Authenticated { get; } + + /// + /// Strings to match this subscription to a received message + /// + public abstract HashSet ListenerIdentifiers { get; set; } + + /// + /// Cancellation token registration + /// + public CancellationTokenRegistration? CancellationTokenRegistration { get; set; } + + /// + /// Exception event + /// + public event Action? Exception; + + /// + /// Get the deserialization type for this message + /// + /// + /// + public abstract Type? GetMessageType(IMessageAccessor message); + + /// + /// ctor + /// + /// + /// + /// + public Subscription(ILogger logger, bool authenticated, bool userSubscription = true) + { + _logger = logger; + Authenticated = authenticated; + UserSubscription = userSubscription; + Id = ExchangeHelpers.NextId(); + } + + /// + /// Get the subscribe query to send when subscribing + /// + /// + public abstract Query? GetSubQuery(SocketConnection connection); + + /// + /// Handle a subscription query response + /// + /// + public virtual void HandleSubQueryResponse(object message) { } + + /// + /// Handle an unsubscription query response + /// + /// + public virtual void HandleUnsubQueryResponse(object message) { } + + /// + /// Get the unsubscribe query to send when unsubscribing + /// + /// + public abstract Query? GetUnsubQuery(); + + /// + public virtual object Deserialize(IMessageAccessor message, Type type) => message.Deserialize(type); + + /// + /// Handle an update message + /// + /// + /// + /// + public async Task HandleAsync(SocketConnection connection, DataEvent message) + { + ConnectionInvocations++; + TotalInvocations++; + return await DoHandleMessageAsync(connection, message).ConfigureAwait(false); + } + + /// + /// Handle the update message + /// + /// + /// + /// + public abstract Task DoHandleMessageAsync(SocketConnection connection, DataEvent message); + + /// + /// Invoke the exception event + /// + /// + public void InvokeExceptionHandler(Exception e) + { + Exception?.Invoke(e); + } + } + + /// + public abstract class Subscription : Subscription + { + /// + /// ctor + /// + /// + /// + protected Subscription(ILogger logger, bool authenticated) : base(logger, authenticated) + { + } + + /// + public override void HandleSubQueryResponse(object message) + => HandleSubQueryResponse((TSubResponse)message); + + /// + /// Handle a subscription query response + /// + /// + public virtual void HandleSubQueryResponse(TSubResponse message) { } + + /// + public override void HandleUnsubQueryResponse(object message) + => HandleUnsubQueryResponse((TUnsubResponse)message); + + /// + /// Handle an unsubscription query response + /// + /// + public virtual void HandleUnsubQueryResponse(TUnsubResponse message) { } + + } +} diff --git a/CryptoExchange.Net/Sockets/SystemSubscription.cs b/CryptoExchange.Net/Sockets/SystemSubscription.cs new file mode 100644 index 0000000..3fb883b --- /dev/null +++ b/CryptoExchange.Net/Sockets/SystemSubscription.cs @@ -0,0 +1,58 @@ +using CryptoExchange.Net.Objects; +using CryptoExchange.Net.Objects.Sockets; +using CryptoExchange.Net.Sockets.MessageParsing.Interfaces; +using Microsoft.Extensions.Logging; +using System; +using System.Threading.Tasks; + +namespace CryptoExchange.Net.Sockets +{ + /// + /// A system subscription + /// + public abstract class SystemSubscription : Subscription + { + /// + /// ctor + /// + /// + /// + public SystemSubscription(ILogger logger, bool authenticated = false) : base(logger, authenticated, false) + { + } + + /// + public override Query? GetSubQuery(SocketConnection connection) => null; + + /// + public override Query? GetUnsubQuery() => null; + } + + /// + public abstract class SystemSubscription : SystemSubscription + { + /// + public override Type GetMessageType(IMessageAccessor message) => typeof(T); + + /// + public override Task DoHandleMessageAsync(SocketConnection connection, DataEvent message) + => HandleMessageAsync(connection, message.As((T)message.Data)); + + /// + /// ctor + /// + /// + /// + protected SystemSubscription(ILogger logger, bool authenticated) : base(logger, authenticated) + { + } + + /// + /// Handle an update message + /// + /// + /// + /// + public abstract Task HandleMessageAsync(SocketConnection connection, DataEvent message); + } +} diff --git a/CryptoExchange.Net/Sockets/WebsocketFactory.cs b/CryptoExchange.Net/Sockets/WebsocketFactory.cs index fd1606b..286d37d 100644 --- a/CryptoExchange.Net/Sockets/WebsocketFactory.cs +++ b/CryptoExchange.Net/Sockets/WebsocketFactory.cs @@ -1,4 +1,5 @@ using CryptoExchange.Net.Interfaces; +using CryptoExchange.Net.Objects.Sockets; using Microsoft.Extensions.Logging; namespace CryptoExchange.Net.Sockets diff --git a/Examples/BlazorClient/BlazorClient.csproj b/Examples/BlazorClient/BlazorClient.csproj index 7dcb550..2adff9c 100644 --- a/Examples/BlazorClient/BlazorClient.csproj +++ b/Examples/BlazorClient/BlazorClient.csproj @@ -5,16 +5,15 @@ - - - - - - - - - - + + + + + + + + + diff --git a/Examples/BlazorClient/Pages/Index.razor b/Examples/BlazorClient/Pages/Index.razor index c43df92..a3b59db 100644 --- a/Examples/BlazorClient/Pages/Index.razor +++ b/Examples/BlazorClient/Pages/Index.razor @@ -2,7 +2,6 @@ @inject IBinanceRestClient binanceClient @inject IBitfinexRestClient bitfinexClient @inject IBitgetRestClient bitgetClient -@inject IBittrexRestClient bittrexClient @inject IBybitRestClient bybitClient @inject ICoinExRestClient coinexClient @inject IHuobiRestClient huobiClient @@ -24,7 +23,6 @@ var binanceTask = binanceClient.SpotApi.ExchangeData.GetTickerAsync("BTCUSDT"); var bitfinexTask = bitfinexClient.SpotApi.ExchangeData.GetTickerAsync("tBTCUSD"); var bitgetTask = bitgetClient.SpotApi.ExchangeData.GetTickerAsync("BTCUSDT_SPBL"); - var bittrexTask = bittrexClient.SpotApi.ExchangeData.GetTickerAsync("BTC-USDT"); var bybitTask = bybitClient.V5Api.ExchangeData.GetSpotTickersAsync("BTCUSDT"); var coinexTask = coinexClient.SpotApi.ExchangeData.GetTickerAsync("BTCUSDT"); var huobiTask = huobiClient.SpotApi.ExchangeData.GetTickerAsync("btcusdt"); @@ -32,7 +30,7 @@ var kucoinTask = kucoinClient.SpotApi.ExchangeData.GetTickerAsync("BTC-USDT"); var okxTask = okxClient.UnifiedApi.ExchangeData.GetTickerAsync("BTCUSDT"); - await Task.WhenAll(binanceTask, bitfinexTask, bittrexTask, bybitTask, coinexTask, huobiTask, krakenTask, kucoinTask); + await Task.WhenAll(binanceTask, bitfinexTask, bybitTask, coinexTask, huobiTask, krakenTask, kucoinTask); if (binanceTask.Result.Success) _prices.Add("Binance", binanceTask.Result.Data.LastPrice); @@ -43,9 +41,6 @@ if (bitgetTask.Result.Success) _prices.Add("Bitget", bitgetTask.Result.Data.ClosePrice); - if (bittrexTask.Result.Success) - _prices.Add("Bittrex", bittrexTask.Result.Data.LastPrice); - if (bybitTask.Result.Success) _prices.Add("Bybit", bybitTask.Result.Data.List.First().LastPrice); diff --git a/Examples/BlazorClient/Pages/LiveData.razor b/Examples/BlazorClient/Pages/LiveData.razor index 7daa044..651e244 100644 --- a/Examples/BlazorClient/Pages/LiveData.razor +++ b/Examples/BlazorClient/Pages/LiveData.razor @@ -2,7 +2,6 @@ @inject IBinanceSocketClient binanceSocketClient @inject IBitfinexSocketClient bitfinexSocketClient @inject IBitgetSocketClient bitgetSocketClient -@inject IBittrexSocketClient bittrexSocketClient @inject IBybitSocketClient bybitSocketClient @inject ICoinExSocketClient coinExSocketClient @inject IHuobiSocketClient huobiSocketClient @@ -11,6 +10,7 @@ @inject IOKXSocketClient okxSocketClient @using System.Collections.Concurrent @using CryptoExchange.Net.Objects +@using CryptoExchange.Net.Objects.Sockets; @using CryptoExchange.Net.Sockets @implements IDisposable @@ -31,13 +31,12 @@ binanceSocketClient.SpotApi.ExchangeData.SubscribeToTickerUpdatesAsync("ETHBTC", data => UpdateData("Binance", data.Data.LastPrice)), bitfinexSocketClient.SpotApi.SubscribeToTickerUpdatesAsync("tETHBTC", data => UpdateData("Bitfinex", data.Data.LastPrice)), bitgetSocketClient.SpotApi.SubscribeToTickerUpdatesAsync("ETHBTC", data => UpdateData("Bitget", data.Data.LastPrice)), - bittrexSocketClient.SpotApi.SubscribeToTickerUpdatesAsync("ETH-BTC", data => UpdateData("Bittrex", data.Data.LastPrice)), bybitSocketClient.V5SpotApi.SubscribeToTickerUpdatesAsync("ETHBTC", data => UpdateData("Bybit", data.Data.LastPrice)), coinExSocketClient.SpotApi.SubscribeToTickerUpdatesAsync("ETHBTC", data => UpdateData("CoinEx", data.Data.LastPrice)), huobiSocketClient.SpotApi.SubscribeToTickerUpdatesAsync("ethbtc", data => UpdateData("Huobi", data.Data.ClosePrice ?? 0)), krakenSocketClient.SpotApi.SubscribeToTickerUpdatesAsync("ETH/XBT", data => UpdateData("Kraken", data.Data.LastTrade.Price)), kucoinSocketClient.SpotApi.SubscribeToTickerUpdatesAsync("ETH-BTC", data => UpdateData("Kucoin", data.Data.LastPrice ?? 0)), - okxSocketClient.UnifiedApi.ExchangeData.SubscribeToTickerUpdatesAsync("ETH-BTC", data => UpdateData("OKX", data.LastPrice ?? 0)), + okxSocketClient.UnifiedApi.ExchangeData.SubscribeToTickerUpdatesAsync("ETH-BTC", data => UpdateData("OKX", data.Data.LastPrice ?? 0)), }; await Task.WhenAll(tasks); diff --git a/Examples/BlazorClient/Pages/OrderBooks.razor b/Examples/BlazorClient/Pages/OrderBooks.razor index 17180b5..1f96691 100644 --- a/Examples/BlazorClient/Pages/OrderBooks.razor +++ b/Examples/BlazorClient/Pages/OrderBooks.razor @@ -4,7 +4,6 @@ @using Binance.Net.Interfaces @using Bitfinex.Net.Interfaces @using Bitget.Net.Interfaces; -@using Bittrex.Net.Interfaces @using Bybit.Net.Interfaces @using CoinEx.Net.Interfaces @using CryptoExchange.Net.Interfaces @@ -16,7 +15,6 @@ @inject IBinanceOrderBookFactory binanceFactory @inject IBitfinexOrderBookFactory bitfinexFactory @inject IBitgetOrderBookFactory bitgetFactory -@inject IBittrexOrderBookFactory bittrexFactory @inject IBybitOrderBookFactory bybitFactory @inject ICoinExOrderBookFactory coinExFactory @inject IHuobiOrderBookFactory huobiFactory @@ -59,7 +57,6 @@ { "Binance", binanceFactory.CreateSpot("ETHBTC") }, { "Bitfinex", bitfinexFactory.Create("tETHBTC") }, { "Bitget", bitgetFactory.CreateSpot("ETHBTC") }, - { "Bittrex", bittrexFactory.Create("ETH-BTC") }, { "Bybit", bybitFactory.Create("ETHBTC", Bybit.Net.Enums.Category.Spot) }, { "CoinEx", coinExFactory.CreateSpot("ETHBTC") }, { "Huobi", huobiFactory.CreateSpot("ethbtc") }, diff --git a/Examples/BlazorClient/Pages/SpotClient.razor b/Examples/BlazorClient/Pages/SpotClient.razor index 742bb48..794766a 100644 --- a/Examples/BlazorClient/Pages/SpotClient.razor +++ b/Examples/BlazorClient/Pages/SpotClient.razor @@ -1,26 +1,5 @@ @page "/SpotClient" -@inject IBinanceRestClient binanceClient -@inject IBitfinexRestClient bitfinexClient -@inject IBitgetRestClient bitgetClient -@inject IBittrexRestClient bittrexClient -@inject IBybitRestClient bybitClient -@inject ICoinExRestClient coinexClient -@inject IHuobiRestClient huobiClient -@inject IKrakenRestClient krakenClient -@inject IKucoinRestClient kucoinClient -@inject IOKXRestClient okxClient -@using Binance.Net.Clients.SpotApi -@using Bitfinex.Net.Clients.SpotApi -@using Bittrex.Net.Clients.SpotApi -@using Bitget.Net.Clients.SpotApi -@using Bybit.Net.Clients.SpotApi -@using CoinEx.Net.Clients.SpotApi -@using CryptoExchange.Net.Interfaces -@using CryptoExchange.Net.Interfaces.CommonClients -@using Huobi.Net.Clients.SpotApi -@using Kraken.Net.Clients.SpotApi -@using Kucoin.Net.Clients.SpotApi -@using OKX.Net.Clients.UnifiedApi +@inject ICryptoRestClient restClient

ETH-BTC prices:

@foreach(var price in _prices.OrderBy(p => p.Key)) @@ -33,21 +12,7 @@ protected override async Task OnInitializedAsync() { - var clients = new ISpotClient[] - { - - binanceClient.SpotApi.CommonSpotClient, - bitfinexClient.SpotApi.CommonSpotClient, - bitgetClient.SpotApi.CommonSpotClient, - bittrexClient.SpotApi.CommonSpotClient, - bybitClient.SpotApiV1.CommonSpotClient, - coinexClient.SpotApi.CommonSpotClient, - huobiClient.SpotApi.CommonSpotClient, - krakenClient.SpotApi.CommonSpotClient, - kucoinClient.SpotApi.CommonSpotClient, - okxClient.UnifiedApi.CommonSpotClient - }; - + var clients = restClient.GetSpotClients(); var tasks = clients.Select(c => (c.ExchangeName, c.GetTickerAsync(c.GetSymbolName("ETH", "BTC")))); await Task.WhenAll(tasks.Select(t => t.Item2)); foreach(var task in tasks) diff --git a/Examples/BlazorClient/Startup.cs b/Examples/BlazorClient/Startup.cs index 5ca272b..914843d 100644 --- a/Examples/BlazorClient/Startup.cs +++ b/Examples/BlazorClient/Startup.cs @@ -1,23 +1,10 @@ -using System.Collections.Generic; -using Binance.Net; -using Binance.Net.Clients; -using Binance.Net.Interfaces.Clients; -using Bitfinex.Net; -using Bitget.Net; -using Bittrex.Net; -using Bybit.Net; -using CoinEx.Net; using CryptoExchange.Net.Authentication; -using Huobi.Net; -using Kraken.Net; -using Kucoin.Net; using Microsoft.AspNetCore.Builder; using Microsoft.AspNetCore.Hosting; using Microsoft.Extensions.Configuration; using Microsoft.Extensions.DependencyInjection; using Microsoft.Extensions.Hosting; using Microsoft.Extensions.Logging; -using OKX.Net; namespace BlazorClient { @@ -51,7 +38,6 @@ namespace BlazorClient services.AddBitfinex(); services.AddBitget(); - services.AddBittrex(); services.AddBybit(); services.AddCoinEx(); services.AddHuobi(); diff --git a/Examples/BlazorClient/_Imports.razor b/Examples/BlazorClient/_Imports.razor index 5796099..a6229d6 100644 --- a/Examples/BlazorClient/_Imports.razor +++ b/Examples/BlazorClient/_Imports.razor @@ -11,10 +11,10 @@ @using Binance.Net.Interfaces.Clients; @using Bitfinex.Net.Interfaces.Clients; @using Bitget.Net.Interfaces.Clients; -@using Bittrex.Net.Interfaces.Clients; @using Bybit.Net.Interfaces.Clients; @using CoinEx.Net.Interfaces.Clients; @using Huobi.Net.Interfaces.Clients; @using Kraken.Net.Interfaces.Clients; @using Kucoin.Net.Interfaces.Clients; -@using OKX.Net.Interfaces.Clients; \ No newline at end of file +@using OKX.Net.Interfaces.Clients; +@using CryptoExchange.Net.Interfaces; \ No newline at end of file diff --git a/Examples/ConsoleClient/ConsoleClient.csproj b/Examples/ConsoleClient/ConsoleClient.csproj index 5289513..5c307b4 100644 --- a/Examples/ConsoleClient/ConsoleClient.csproj +++ b/Examples/ConsoleClient/ConsoleClient.csproj @@ -6,16 +6,16 @@ - - + + - - - - - - - + + + + + + + diff --git a/Examples/ConsoleClient/Exchanges/BinanceExchange.cs b/Examples/ConsoleClient/Exchanges/BinanceExchange.cs index 0a2004b..5f90648 100644 --- a/Examples/ConsoleClient/Exchanges/BinanceExchange.cs +++ b/Examples/ConsoleClient/Exchanges/BinanceExchange.cs @@ -7,6 +7,7 @@ using Binance.Net.Clients; using Binance.Net.Interfaces.Clients; using ConsoleClient.Models; using CryptoExchange.Net.Objects; +using CryptoExchange.Net.Objects.Sockets; using CryptoExchange.Net.Sockets; namespace ConsoleClient.Exchanges diff --git a/Examples/ConsoleClient/Exchanges/BybitExchange.cs b/Examples/ConsoleClient/Exchanges/BybitExchange.cs index 0b33e51..580b5c3 100644 --- a/Examples/ConsoleClient/Exchanges/BybitExchange.cs +++ b/Examples/ConsoleClient/Exchanges/BybitExchange.cs @@ -2,6 +2,7 @@ using Bybit.Net.Interfaces.Clients; using ConsoleClient.Models; using CryptoExchange.Net.Objects; +using CryptoExchange.Net.Objects.Sockets; using CryptoExchange.Net.Sockets; using System; using System.Collections.Generic; diff --git a/Examples/ConsoleClient/Exchanges/IExchange.cs b/Examples/ConsoleClient/Exchanges/IExchange.cs index dcd1ff1..d0b7ea1 100644 --- a/Examples/ConsoleClient/Exchanges/IExchange.cs +++ b/Examples/ConsoleClient/Exchanges/IExchange.cs @@ -1,5 +1,6 @@ using ConsoleClient.Models; using CryptoExchange.Net.Objects; +using CryptoExchange.Net.Objects.Sockets; using CryptoExchange.Net.Sockets; using System; using System.Collections.Generic; diff --git a/Examples/ConsoleClient/Program.cs b/Examples/ConsoleClient/Program.cs index dfb5f71..66ebc2b 100644 --- a/Examples/ConsoleClient/Program.cs +++ b/Examples/ConsoleClient/Program.cs @@ -8,6 +8,7 @@ using Binance.Net.Objects; using Bybit.Net.Clients; using ConsoleClient.Exchanges; using CryptoExchange.Net.Authentication; +using CryptoExchange.Net.Objects.Sockets; using CryptoExchange.Net.Sockets; namespace ConsoleClient diff --git a/README.md b/README.md index 56b53ef..c29cde3 100644 --- a/README.md +++ b/README.md @@ -1,26 +1,35 @@ -# CryptoExchange.Net -[![.NET](https://github.com/JKorf/CryptoExchange.Net/actions/workflows/dotnet.yml/badge.svg?branch=master)](https://github.com/JKorf/CryptoExchange.Net/actions/workflows/dotnet.yml) [![Nuget version](https://img.shields.io/nuget/v/CryptoExchange.Net.svg)](https://www.nuget.org/packages/CryptoExchange.Net) [![Nuget downloads](https://img.shields.io/nuget/dt/CryptoExchange.Net.svg)](https://www.nuget.org/packages/CryptoExchange.Net) +# CryptoExchange.Net -CryptoExchange.Net is a base package which can be used to easily implement crypto currency exchange API's in C#. This library offers base classes for creating rest and websocket clients, and includes additional features like an automatically synchronizing order book implementation, error handling and automatic reconnects on websocket connections. +[![.NET](https://img.shields.io/github/actions/workflow/status/JKorf/CryptoExchange.Net/dotnet.yml?style=for-the-badge)](https://github.com/JKorf/CryptoExchange.Net/actions/workflows/dotnet.yml) [![Nuget downloads](https://img.shields.io/nuget/dt/CryptoExchange.Net.svg?style=for-the-badge)](https://www.nuget.org/packages/CryptoExchange.Net) ![License](https://img.shields.io/github/license/JKorf/CryptoExchange.Net?style=for-the-badge) -[Documentation](https://jkorf.github.io/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. + +For more information on what CryptoExchange.Net and it's client libraries offers see the [Documentation](https://jkorf.github.io/CryptoExchange.Net/). + +### Current implementations +The following API's are directly supported. Note that there are 3rd party implementations going around, but only these are created and supported by me: + +|Exchange|Repository|Nuget| +|--|--|--| +|Binance|[JKorf/Binance.Net](https://github.com/JKorf/Binance.Net)|[![Nuget version](https://img.shields.io/nuget/v/Binance.net.svg?style=flat-square)](https://www.nuget.org/packages/Binance.Net)| +|Bitfinex|[JKorf/Bitfinex.Net](https://github.com/JKorf/Bitfinex.Net)|[![Nuget version](https://img.shields.io/nuget/v/Bitfinex.net.svg?style=flat-square)](https://www.nuget.org/packages/Bitfinex.Net)| +|Bitget|[JKorf/Bitget.Net](https://github.com/JKorf/Bitget.Net)|[![Nuget version](https://img.shields.io/nuget/v/Bitget.net.svg?style=flat-square)](https://www.nuget.org/packages/Bitget.Net)| +|Bybit|[JKorf/Bybit.Net](https://github.com/JKorf/Bybit.Net)|[![Nuget version](https://img.shields.io/nuget/v/Bybit.net.svg?style=flat-square)](https://www.nuget.org/packages/Bybit.Net)| +|CoinEx|[JKorf/CoinEx.Net](https://github.com/JKorf/CoinEx.Net)|[![Nuget version](https://img.shields.io/nuget/v/CoinEx.net.svg?style=flat-square)](https://www.nuget.org/packages/CoinEx.Net)| +|CoinGecko|[JKorf/CoinGecko.Net](https://github.com/JKorf/CoinGecko.Net)|[![Nuget version](https://img.shields.io/nuget/v/CoinGecko.net.svg?style=flat-square)](https://www.nuget.org/packages/CoinGecko.Net)| +|Huobi/HTX|[JKorf/Huobi.Net](https://github.com/JKorf/Huobi.Net)|[![Nuget version](https://img.shields.io/nuget/v/Huobi.net.svg?style=flat-square)](https://www.nuget.org/packages/Huobi.Net)| +|Kraken|[JKorf/Kraken.Net](https://github.com/JKorf/Kraken.Net)|[![Nuget version](https://img.shields.io/nuget/v/KrakenExchange.net.svg?style=flat-square)](https://www.nuget.org/packages/KrakenExchange.Net)| +|Kucoin|[JKorf/Kucoin.Net](https://github.com/JKorf/Kucoin.Net)|[![Nuget version](https://img.shields.io/nuget/v/Kucoin.net.svg?style=flat-square)](https://www.nuget.org/packages/Kucoin.Net)| +|Mexc|[JKorf/Mexc.Net](https://github.com/JKorf/Mexc.Net)|[![Nuget version](https://img.shields.io/nuget/v/JK.Mexc.net.svg?style=flat-square)](https://www.nuget.org/packages/JK.Mexc.Net)| +|OKX|[JKorf/OKX.Net](https://github.com/JKorf/OKX.Net)|[![Nuget version](https://img.shields.io/nuget/v/JK.OKX.net.svg?style=flat-square)](https://www.nuget.org/packages/JK.OKX.Net)| ## Discord +[![Nuget version](https://img.shields.io/discord/847020490588422145?style=for-the-badge)](https://discord.gg/MSpeEtSY8t) A Discord server is available [here](https://discord.gg/MSpeEtSY8t). Feel free to join for discussion and/or questions around the CryptoExchange.Net and implementation libraries. ## Support the project I develop and maintain this package on my own for free in my spare time, any support is greatly appreciated. -### Referral link -Use one of the following following referral links to signup to a new exchange to pay a small percentage of the trading fees you pay to support the project instead of paying them straight to the exchange. This doesn't cost you a thing! -[Binance](https://accounts.binance.com/en/register?ref=10153680) -[Bitfinex](https://www.bitfinex.com/sign-up?refcode=kCCe-CNBO) -[Bittrex](https://bittrex.com/discover/join?referralCode=TST-DJM-CSX) -[Bybit](https://partner.bybit.com/b/jkorf) -[CoinEx](https://www.coinex.com/register?refer_code=hd6gn) -[Huobi](https://www.huobi.com/en-us/v/register/double-invite/?inviter_id=11343840&invite_code=fxp93) -[Kucoin](https://www.kucoin.com/ucenter/signup?rcode=RguMux) - ### Donate Make a one time donation in a crypto currency of your choice. If you prefer to donate a currency not listed here please contact me. @@ -31,6 +40,19 @@ Make a one time donation in a crypto currency of your choice. If you prefer to d Alternatively, sponsor me on Github using [Github Sponsors](https://github.com/sponsors/JKorf). ## Release notes +* Version 7.0.0-beta2 - 21 Feb 2024 + * Updated RevitalizeRequestAsync signature + * Removed duplicate logging + +* Version 7.0.0-beta1 - 06 Feb 2024 + * Full overhaul of Websocket message handling + * Abstracted out Newtonsoft.Json references in preparation of moving to System.Text.Json + * Updated SendPeriodic to operate on connection level instead of client level to prevent looping when there are no connections + * Added check to not send an unsubscribe message if there is another subscription listening to the same events + * Added CryptoRestClient and CryptoSocketClient as aggregate for accessing different exchange APIs + * Updated socket client log messages + * Updated socket client GetSubscriptionState output + * Version 6.2.5 - 09 Jan 2024 * Added support for deserializing null and empty string values to BoolConverter diff --git a/docs/Clients.md b/docs/Clients.md deleted file mode 100644 index a03786b..0000000 --- a/docs/Clients.md +++ /dev/null @@ -1,171 +0,0 @@ ---- -title: General usage -nav_order: 2 ---- - -## How to use the library - -Each implementation generally provides two different clients, which will be the access point for the API's. First of is the rest client, which is typically available via [ExchangeName]RestClient, and a socket client, which is generally named [ExchangeName]SocketClient. For example `BinanceRestClient` and `BinanceSocketClient`. - -## Rest client -The rest client gives access to the Rest endpoint of the API. Rest endpoints are accessed by sending an HTTP request and receiving a response. The client is split in different sub-clients, which are named API Clients. These API clients are then again split in different topics. Typically a Rest client will look like this: - -- [ExchangeName]RestClient - - SpotApi - - Account - - ExchangeData - - Trading - - FuturesApi - - Account - - ExchangeData - - Trading - -This rest client has 2 different API clients, the `SpotApi` and the `FuturesApi`, each offering their own set of endpoints. - -*Requesting ticker info on the spot API* -```csharp -var client = new KucoinClient(); -var tickersResult = kucoinClient.SpotApi.ExchangeData.GetTickersAsync(); -``` - -Structuring the client like this should make it easier to find endpoints and allows for separate options and functionality for different API clients. For example, some API's have totally separate API's for futures, with different base addresses and different API credentials, while other API's have implemented this in the same API. Either way, this structure can facilitate a similar interface. - -### Rest API client -The Api clients are parts of the total API with a common identifier. In the previous example, it separates the Spot and the Futures API. This again is then separated into topics. Most Rest clients implement the following structure: - -**Account** -Endpoints related to the user account. This can for example be endpoints for accessing account settings, or getting account balances. The endpoints in this topic will require API credentials to be provided in the client options. - -**ExchangeData** -Endpoints related to exchange data. Exchange data can be tied to the exchange, for example retrieving the symbols supported by the exchange and what the trading rules are, or can be more general market endpoints, such as getting the most recent trades for a symbol. -These endpoints generally don't require API credentials as they are publicly available. - -**Trading** -Endpoints related to trading. These are endpoints for placing and retrieving orders and retrieving trades made by the user. The endpoints in this topic will require API credentials to be provided in the client options. - -### Processing request responses -Each request will return a WebCallResult with the following properties: -`RequestHeaders`: The headers send to the server in the request message -`RequestMethod`: The Http method of the request -`RequestUrl`: The url the request was send to -`ResponseLength`: The length in bytes of the response message -`ResponseTime`: The duration between sending the request and receiving the response -`ResponseHeaders`: The headers returned from the server -`ResponseStatusCode`: The status code as returned by the server -`Success`: Whether or not the call was successful. If successful the `Data` property will contain the resulting data, if not successful the `Error` property will contain more details about what the issue was -`Error`: Details on what went wrong with a call. Only filled when `Success` == `false` -`OriginalData`: Will contain the originally received unparsed data if this has been enabled in the client options -`Data`: Data returned by the server, only available if `Success` == `true` - -When processing the result of a call it should always be checked for success. Not doing so will result in `NullReference` exceptions when the call fails for whatever reason. - -*Check call result* -```csharp -var callResult = await kucoinClient.SpotApi.ExchangeData.GetTickersAsync(); -if(!callResult.Success) -{ - Console.WriteLine("Request failed: " + callResult.Error); - return; -} - -Console.WriteLine("Result: " + callResult.Data); -``` - -## Socket client -The socket client gives access to the websocket API of an exchange. Websocket API's offer streams to which updates are pushed to which a client can listen, and sometimes also allow request/response communication. -Just like the Rest client is divided in Rest Api clients, the Socket client is divided into Socket Api clients, each with their own range of API functionality. Socket Api clients are generally not divided into topics since the number of methods isn't as big as with the Rest client. To use the Kucoin client as example again, it looks like this: - -```csharp - -- KucoinSocketClient - - SpotStreams - - FuturesStreams - -``` -*Subscribing to updates for all tickers on the Spot Api* -```csharp -var subscribeResult = kucoinSocketClient.SpotStreams.SubscribeToAllTickerUpdatesAsync(DataHandler); -``` - -Subscribe methods always require a data handler parameter, which is the method which will be called when an update is received from the server. This can be the name of a method or a lambda expression. - -*Method reference* -```csharp -await kucoinSocketClient.SpotStreams.SubscribeToAllTickerUpdatesAsync(DataHandler); - -private static void DataHandler(DataEvent updateData) -{ - // Process updateData -} -``` - -*Lambda* -```csharp -await kucoinSocketClient.SpotStreams.SubscribeToAllTickerUpdatesAsync(updateData => -{ - // Process updateData -}); -``` - -All updates are wrapped in a `DataEvent<>` object, which contain the following properties: -`Timestamp`: The timestamp when the data was received (not send!) -`OriginalData`: Will contain the originally received unparsed data if this has been enabled in the client options -`Topic`: Will contain the topic of the update, which is typically the symbol or asset the update is for -`Data`: Contains the received update data. - -*[WARNING] Do not use `using` statements in combination with constructing a `SocketClient` without blocking the thread. Doing so will dispose the `SocketClient` instance when the subscription is done, which will result in the connection getting closed. Instead assign the socket client to a variable outside of the method scope.* - -### Processing subscribe responses -Subscribing to a stream will return a `CallResult` object. This should be checked for success the same way as a [rest request](#processing-request-responses). The `UpdateSubscription` object can be used to listen for connection events of the socket connection. -```csharp - -var subscriptionResult = await kucoinSocketClient.SpotStreams.SubscribeToAllTickerUpdatesAsync(DataHandler); -if(!subscriptionResult.Success) -{ - Console.WriteLine("Failed to connect: " + subscriptionResult.Error); - return; -} -subscriptionResult.Data.ConnectionLost += () => -{ - Console.WriteLine("Connection lost"); -}; -subscriptionResult.Data.ConnectionRestored += (time) => -{ - Console.WriteLine("Connection restored"); -}; - -``` - -### Unsubscribing -When no longer interested in specific updates there are a few ways to unsubscribe. - -**Close subscription** -Subscribing to an update stream will respond with an `UpdateSubscription` object. You can call the `CloseAsync()` method on this to no longer receive updates from that subscription: -```csharp -var subscriptionResult = await kucoinSocketClient.SpotStreams.SubscribeToAllTickerUpdatesAsync(DataHandler); -await subscriptionResult.Data.CloseAsync(); -``` - -**Cancellation token** -Passing in a `CancellationToken` as parameter in the subscribe method will allow you to cancel subscriptions by canceling the token. This can be useful when you need to cancel some streams but not others. In this example, both `BTC-USDT` and `ETH-USDT` streams get canceled, while the `KCS-USDT` stream remains active. -```csharp -var cts = new CancellationTokenSource(); -var subscriptionResult1 = await kucoinSocketClient.SpotStreams.SubscribeToTickerUpdatesAsync("BTC-USDT", DataHandler, cts.Token); -var subscriptionResult2 = await kucoinSocketClient.SpotStreams.SubscribeToTickerUpdatesAsync("ETH-USDT", DataHandler, cts.Token); -var subscriptionResult3 = await kucoinSocketClient.SpotStreams.SubscribeToTickerUpdatesAsync("KCS-USDT", DataHandler); -Console.ReadLine(); -cts.Cancel(); -``` - -**Client unsubscribe** -Subscriptions can also be closed by calling the `UnsubscribeAsync` method on the client, while providing either the `UpdateSubscription` object or the subscription id: -```csharp -var subscriptionResult = await kucoinSocketClient.SpotStreams.SubscribeToTickerUpdatesAsync("BTC-USDT", DataHandler); -await kucoinSocketClient.UnsubscribeAsync(subscriptionResult.Data); -// OR -await kucoinSocketClient.UnsubscribeAsync(subscriptionResult.Data.Id); -``` - -When you need to unsubscribe all current subscriptions on a client you can call `UnsubscribeAllAsync` on the client to unsubscribe all streams and close all connections. - - diff --git a/docs/FAQ.md b/docs/FAQ.md deleted file mode 100644 index 9087c13..0000000 --- a/docs/FAQ.md +++ /dev/null @@ -1,60 +0,0 @@ ---- -title: FAQ -nav_order: 12 ---- - -## Frequently asked questions - -### I occasionally get a NullReferenceException, what's wrong? -You probably don't check the result status of a call and just assume the data is always there. `NullReferenceExecption`s will happen when you have code like this `var symbol = client.GetTickersAync().Result.Data.Symbol` because the `Data` property is null when the call fails. Instead check if the call is successful like this: -```csharp -var tickerResult = await client.GetTickersAync(); -if(!tickerResult.Success) -{ - // Handle error -} -else -{ - // Handle result, it is now safe to access the Data property - var symbol = tickerResult.Data.Symbol; -} -``` - -### The socket client stops sending updates after a little while -You probably didn't keep a reference to the socket client and it got disposed. -Instead of subscribing like this: -```csharp -private void SomeMethod() -{ - var socketClient = new BinanceSocketClient(); - socketClient.Spot.SubscribeToOrderBookUpdates("BTCUSDT", data => { - // Handle data - }); -} -``` -Subscribe like this: -```csharp -private BinanceSocketClient _socketClient = new BinanceSocketClient(); - -// .. rest of the class - -private void SomeMethod() -{ - _socketClient.Spot.SubscribeToOrderBookUpdates("BTCUSDT", data => { - // Handle data - }); -} - -``` - -### Can I use the TestNet/US/other API with this library -Yes, generally these are all supported and can be configured by setting the Environment in the client options. Some known environments should be available in the [Exchange]Environment class. For example: -```csharp -var client = new BinanceRestClient(options => -{ - options.Environment = BinanceEnvironment.Testnet; -}); -``` - -### How are timezones handled / Timestamps are off by xx -Exchange API's treat all timestamps as UTC, both incoming and outgoing. The client libraries do no conversion so be sure to use UTC as well. \ No newline at end of file diff --git a/docs/Glossary.md b/docs/Glossary.md deleted file mode 100644 index f8c38bc..0000000 --- a/docs/Glossary.md +++ /dev/null @@ -1,28 +0,0 @@ ---- -title: Glossary -nav_order: 11 ---- -## Terms and definitions - -|Definition|Synonyms|Meaning| -|----------|--------|-------| -|Symbol|Market|An asset pair, for example `BTC-ETH`| -|Asset|Currency, Coin|A coin for which you can hold balance and which makes up Symbols. For example both `BTC`, `ETH` or `USD`| -|Trade|Execution, fill|The (partial) execution of an order. Orders can have multiple trades| -|Quantity|Amount, Size|The amount of asset| -|Fee|Commission|The fee paid for an order or trade| -|Kline|Candlestick, OHLC|K-line data, used for candlestick charts. Contains Open/High/Low/Close/Volume| -|KlineInterval|The time period of a single kline| -|Open order|Active order, Unexecuted order|An order which has not yet been fully filled| -|Closed order|Completed order, executed order|An order which is no longer active. Can be canceled or fully filled| -|Network|Chain|The network of an asset. For example `ETH` allows multiple networks like `ERC20` and `BEP2`| -|Order book|Market depth|A list of (the top rows of) the current best bids and asks| -|Ticker|Stats|Statistics over the last 24 hours| -|Client implementation|Library|An implementation of the `CrytpoExchange.Net` library. For example `Binance.Net` or `Bybit.Net`| - -### Other naming conventions -#### PlaceOrderAsync -Methods for creating an order are always named `PlaceOrderAsync`, with and optional additional name for the type of order, for example `PlaceMarginOrderAsync`. - -#### GetOrdersAsync/GetOpenOrdersAsync/GetClosedOrdersAsync -`GetOpenOrdersAsync` only retrieves orders which are still active, `GetClosedOrdersAsync` only retrieves orders which are canceled/closed. `GetOrdersAsync` retrieves both open and closed orders. \ No newline at end of file diff --git a/docs/Implementation.md b/docs/Implementation.md deleted file mode 100644 index 2a4acfd..0000000 --- a/docs/Implementation.md +++ /dev/null @@ -1,6 +0,0 @@ ---- -title: Creating an implementation -nav_order: 8 ---- - -TODO \ No newline at end of file diff --git a/docs/Interfaces.md b/docs/Interfaces.md deleted file mode 100644 index dc76026..0000000 --- a/docs/Interfaces.md +++ /dev/null @@ -1,145 +0,0 @@ ---- -title: Common interfaces -nav_order: 7 ---- - -## Shared interfaces -Clients have a common interface implementation to allow a shared code base to use the same functionality for different exchanges. The interface is implemented at the `API` level, for example: -```csharp -var binanceClient = new BinanceClient(); -ISpotClient spotClient = binanceClient.SpotApi.CommonSpotClient; -IFuturesClient futuresClient = binanceClient.UsdFuturesApi.CommonFuturesClient; -``` - -For examples on this see the Examples folder. - -## ISpotClient -The `ISpotClient` interface is implemented on Spot API clients. The interface exposes basic functionality like retrieving market data and managing orders. The `ISpotClient` interface will be available via the `CommonSpotClient` property on the Api client. -The spot client has the following members: - -*Properties* -```csharp -// The name of the exchange this client interacts with -string ExchangeName { get; } -``` - -*Events* -```csharp -// Event when placing an order with this ISpotClient. Note that this is not an event handler listening on the exchange, just an event handler for when the `PlaceOrderAsync` method is called. -event Action OnOrderPlaced; -// Event when canceling an order with this ISpotClient. Note that this is not an event handler listening on the exchange, just an event handler for when the `CancelOrderAsync` method is called. -event Action OnOrderCanceled; - -``` - -*Methods* -```csharp -// Retrieve the name of a symbol based on 2 assets. This will format them in the way the exchange expects them. For example BTC, USDT will return BTCUSDT on Binance and BTC-USDT on Kucoin -string GetSymbolName(string baseAsset, string quoteAsset); - -// Get a list of symbols (trading pairs) on the exchange -Task>> GetSymbolsAsync(); - -// Get the ticker (24 hour stats) for a symbol -Task> GetTickerAsync(string symbol); - -// Get a list of tickers for all symbols -Task>> GetTickersAsync(); - -// Get a list klines (candlesticks) for a symbol -Task>> GetKlinesAsync(string symbol, TimeSpan timespan, DateTime? startTime = null, DateTime? endTime = null, int? limit = null); - -// Get the order book for a symbol -Task> GetOrderBookAsync(string symbol); - -// Get a list of most recent trades -Task>> GetRecentTradesAsync(string symbol); - -// Get balances -Task>> GetBalancesAsync(string? accountId = null); - -// Place an order -Task> PlaceOrderAsync(string symbol, CommonOrderSide side, CommonOrderType type, decimal quantity, decimal? price = null, string? accountId = null); - -// Get order by order id -Task> GetOrderAsync(string orderId, string? symbol = null); - -// Get the trades for an order -Task>> GetOrderTradesAsync(string orderId, string? symbol = null); - -// Get a list of open orders. Some exchanges require a symbol -Task>> GetOpenOrdersAsync(string? symbol = null); - -// Get a list of closed orders. Some exchanges require a symbol -Task>> GetClosedOrdersAsync(string? symbol = null); - -// Cancel an active order -Task> CancelOrderAsync(string orderId, string? symbol = null); -``` - -## IFuturesClient -The `IFuturesClient` interface is implemented on Futures API clients. The interface exposes basic functionality like retrieving market data and managing orders. The `IFuturesClient` interface will be available via the `CommonFuturesClient` property on the Api client. -The spot client has the following members: - -*Properties* -```csharp -// The name of the exchange this client interacts with -string ExchangeName { get; } -``` - -*Events* -```csharp -// Event when placing an order with this ISpotClient. Note that this is not an event handler listening on the exchange, just an event handler for when the `PlaceOrderAsync` method is called. -event Action OnOrderPlaced; -// Event when canceling an order with this ISpotClient. Note that this is not an event handler listening on the exchange, just an event handler for when the `CancelOrderAsync` method is called. -event Action OnOrderCanceled; - -``` - -*Methods* -```csharp -// Retrieve the name of a symbol based on 2 assets. This will format them in the way the exchange expects them. For example BTC, USDT will return BTCUSDT on Binance and BTC-USDT on Kucoin -string GetSymbolName(string baseAsset, string quoteAsset); - -// Get a list of symbols (trading pairs) on the exchange -Task>> GetSymbolsAsync(); - -// Get the ticker (24 hour stats) for a symbol -Task> GetTickerAsync(string symbol); - -// Get a list of tickers for all symbols -Task>> GetTickersAsync(); - -// Get a list klines (candlesticks) for a symbol -Task>> GetKlinesAsync(string symbol, TimeSpan timespan, DateTime? startTime = null, DateTime? endTime = null, int? limit = null); - -// Get the order book for a symbol -Task> GetOrderBookAsync(string symbol); - -// Get a list of most recent trades -Task>> GetRecentTradesAsync(string symbol); - -// Get balances -Task>> GetBalancesAsync(string? accountId = null); - -// Get current open positions -Task>> GetPositionsAsync(); - -// Place an order -Task> PlaceOrderAsync(string symbol, CommonOrderSide side, CommonOrderType type, decimal quantity, decimal? price = null, int? leverage = null, string? accountId = null); - -// Get order by order id -Task> GetOrderAsync(string orderId, string? symbol = null); - -// Get the trades for an order -Task>> GetOrderTradesAsync(string orderId, string? symbol = null); - -// Get a list of open orders. Some exchanges require a symbol -Task>> GetOpenOrdersAsync(string? symbol = null); - -// Get a list of closed orders. Some exchanges require a symbol -Task>> GetClosedOrdersAsync(string? symbol = null); - -// Cancel an active order -Task> CancelOrderAsync(string orderId, string? symbol = null); -``` \ No newline at end of file diff --git a/docs/Logging.md b/docs/Logging.md deleted file mode 100644 index 1f37bf5..0000000 --- a/docs/Logging.md +++ /dev/null @@ -1,150 +0,0 @@ ---- -title: Logging -nav_order: 5 ---- - -## Configuring logging -The library offers extensive logging, which depends on the dotnet `Microsoft.Extensions.Logging.ILogger` interface. This should provide ease of use when connecting the library logging to your existing logging implementation. - -*Configure logging to write to the console* -```csharp -IServiceCollection services = new ServiceCollection(); -services - .AddBinance() - .AddLogging(options => - { - options.SetMinimumLevel(LogLevel.Trace); - options.AddConsole(); - }); -``` - -The library provides a TraceLogger ILogger implementation which writes log messages using `Trace.WriteLine`, but any other logging library can be used. - -*Configure logging to use trace logging* -```csharp -IServiceCollection serviceCollection = new ServiceCollection(); -serviceCollection.AddBinance() - .AddLogging(options => - { - options.SetMinimumLevel(LogLevel.Trace); - options.AddProvider(new TraceLoggerProvider()); - }); -``` - -### Using an external logging library and dotnet DI - -With for example an ASP.Net Core or Blazor project the logging can be configured by the dependency container, which can then automatically be used be the clients. -The next example shows how to use Serilog. This assumes the `Serilog.AspNetCore` package (https://github.com/serilog/serilog-aspnetcore) is installed. - -*Using serilog:* -```csharp -using Binance.Net; -using Serilog; - -Log.Logger = new LoggerConfiguration() - .MinimumLevel.Debug() - .WriteTo.Console() - .CreateLogger(); - -var builder = WebApplication.CreateBuilder(args); -builder.Services.AddBinance(); -builder.Host.UseSerilog(); -var app = builder.Build(); - -// startup - -app.Run(); -``` - -### Logging without dotnet DI -If you don't have a dependency injection service available because you are for example working on a simple console application you have 2 options for logging. - -#### Create a ServiceCollection manually and get the client from the service provider - -```csharp -IServiceCollection serviceCollection = new ServiceCollection(); -serviceCollection.AddBinance(); -serviceCollection.AddLogging(options => -{ - options.SetMinimumLevel(LogLevel.Trace); - options.AddConsole(); -}).BuildServiceProvider(); - -var client = serviceCollection.GetRequiredService(); - -``` - -#### Create a LoggerFactory manually - -```csharp -var logFactory = new LoggerFactory(); -logFactory.AddProvider(new ConsoleLoggerProvider()); -var binanceClient = new BinanceRestClient(new HttpClient(), logFactory, options => { }); -``` - -## Providing logging for issues -A big debugging tool when opening an issue on Github is providing logging of what data caused the issue. This can be provided two ways, via the `OriginalData` property of the call result or data event, or collecting the Trace logging. -### OriginalData -This is only useful when there is an issue in deserialization. So either a call result is giving a Deserialization error, or the result has a value that is unexpected. If that is the issue, please provide the original data that is received so the deserialization issue can be resolved based on the received data. -By default the `OriginalData` property in the `WebCallResult`/`DataEvent` object is not filled as saving the original data has a (very small) performance penalty. To save the original data in the `OriginalData` property the `OutputOriginalData` option should be set to `true` in the client options. -*Enabled output data* -```csharp -var client = new BinanceClient(options => -{ - options.OutputOriginalData = true -}); -``` - -*Accessing original data* -```csharp -// Rest request -var tickerResult = await client.SpotApi.ExchangeData.GetTickersAsync(); -var originallyReceivedData = tickerResult.OriginalData; - -// Socket update -await client.SpotStreams.SubscribeToAllTickerUpdatesAsync(update => { - var originallyRecievedData = update.OriginalData; -}); -``` - -### Trace logging -Trace logging, which is the most verbose log level, will show everything the library does and includes the data that was send and received. -Output data will look something like this: -``` -2021-12-17 10:40:42:296 | Debug | Binance | Client configuration: LogLevel: Trace, Writers: 1, OutputOriginalData: False, Proxy: -, AutoReconnect: True, ReconnectInterval: 00:00:05, MaxReconnectTries: , MaxResubscribeTries: 5, MaxConcurrentResubscriptionsPerSocket: 5, SocketResponseTimeout: 00:00:10, SocketNoDataTimeout: 00:00:00, SocketSubscriptionsCombineTarget: , CryptoExchange.Net: v5.0.0.0, Binance.Net: v8.0.0.0 -2021-12-17 10:40:42:410 | Debug | Binance | [15] Creating request for https://api.binance.com/api/v3/ticker/24hr -2021-12-17 10:40:42:439 | Debug | Binance | [15] Sending GET request to https://api.binance.com/api/v3/ticker/24hr?symbol=BTCUSDT with headers Accept=[application/json], X-MBX-APIKEY=[XXX] -2021-12-17 10:40:43:024 | Debug | Binance | [15] Response received in 571ms: {"symbol":"BTCUSDT","priceChange":"-1726.47000000","priceChangePercent":"-3.531","weightedAvgPrice":"48061.51544204","prevClosePrice":"48901.44000000","lastPrice":"47174.97000000","lastQty":"0.00352000","bidPrice":"47174.96000000","bidQty":"0.65849000","askPrice":"47174.97000000","askQty":"0.13802000","openPrice":"48901.44000000","highPrice":"49436.43000000","lowPrice":"46749.55000000","volume":"33136.69765000","quoteVolume":"1592599905.80360790","openTime":1639647642763,"closeTime":1639734042763,"firstId":1191596486,"lastId":1192649611,"count":1053126} -``` -When opening an issue, please provide this logging when available. - -### Example of serilog config and minimal API's - -```csharp -using Binance.Net; -using Binance.Net.Interfaces.Clients; -using Serilog; - -Log.Logger = new LoggerConfiguration() - .MinimumLevel.Debug() - .WriteTo.Console() - .CreateLogger(); - -var builder = WebApplication.CreateBuilder(args); -builder.Services.AddBinance(); -builder.Host.UseSerilog(); -var app = builder.Build(); - -// startup - -app.Urls.Add("http://localhost:3000"); - -app.MapGet("/price/{symbol}", async (string symbol) => -{ - var client = app.Services.GetRequiredService(); - var result = await client.SpotApi.ExchangeData.GetPriceAsync(symbol); - return result.Data.Price; -}); - -app.Run(); -``` \ No newline at end of file diff --git a/docs/Migration Guide.md b/docs/Migration Guide.md deleted file mode 100644 index 4b3b51b..0000000 --- a/docs/Migration Guide.md +++ /dev/null @@ -1,73 +0,0 @@ ---- -title: Migrate v5 to v6 -nav_order: 10 ---- - -## Migrating from version 5 to version 6 -When updating your code from version 5 implementations to version 6 implementations you will encounter some breaking changes. Here is the general outline of changes made in the CryptoExchange.Net library. For more specific changes for each library visit the library migration guide. - -*NOTE when updating it is not possible to have some client implementations use a V5 version and some clients a V6. When updating all libraries should be migrated* - -## Rest client name -To be more clear about different clients for different API's the rest client implementations have been renamed from [Exchange]Client to [Exchange]RestClient. This makes it more clear that it only implements the Rest API and the [Exchange]SocketClient the Socket API. - -## Options -Option parameters have been changed to a callback instead of an options object. This makes processing of the options easier and is in line with how dotnet handles option configurations. - -**BaseAddress** -The BaseAddress option has been replaced by the Environment option. The Environment options allows for selection/switching between different trade environments more easily. For example the environment can be switched between a testnet and live by changing only a single line instead of having to change all BaseAddresses. - -**LogLevel/LogWriters** -The logging options have been removed and are now inherited by the DI configuration. See [Logging](https://jkorf.github.io/CryptoExchange.Net/Logging.html) for more info. - -**HttpClient** -The HttpClient will now be received by the DI container instead of having to pass it manually. When not using DI it is still possible to provide a HttpClient, but it is now located in the client constructor. - -*V5* -```csharp -var client = new BinanceClient(new BinanceClientOptions(){ - OutputOriginalData = true, - SpotApiOptions = new RestApiOptions { - BaseAddress = BinanceApiAddresses.TestNet.RestClientAddress - } - // Other options -}); -``` - -*V6* -```csharp -var client = new BinanceClient(options => { - options.OutputOriginalData = true; - options.Environment = BinanceEnvironment.Testnet; - // Other options -}); -``` - -## Socket api name -As socket API's are often more than just streams to subscribe to the name of the socket API clients have been changed from [Topic]Streams to [Topic]Api which matches the rest API client names. For example `SpotStreams` has become `SpotApi`, so `binanceSocketClient.UsdFuturesStreams.SubscribeXXX` has become `binanceSocketClient.UsdFuturesApi.SubscribeXXX`. - -## Add[Exchange] extension method -With the change in options providing the DI extension methods for the IServiceCollection have also been changed slightly. Also the socket clients will now be registered as Singleton by default instead of Scoped. - -*V5* -```csharp -builder.Services.AddKucoin((restOpts, socketOpts) => -{ - restOpts.LogLevel = LogLevel.Debug; - restOpts.ApiCredentials = new KucoinApiCredentials("KEY", "SECRET", "PASS"); - socketOpts.LogLevel = LogLevel.Debug; - socketOpts.ApiCredentials = new KucoinApiCredentials("KEY", "SECRET", "PASS"); -}, ServiceLifetime.Singleton); -``` - -*V6* -```csharp -builder.Services.AddKucoin((restOpts) => -{ - restOpts.ApiCredentials = new KucoinApiCredentials("KEY", "SECRET", "PASS"); -}, -(socketOpts) => -{ - socketOpts.ApiCredentials = new KucoinApiCredentials("KEY", "SECRET", "PASS"); -}); -``` \ No newline at end of file diff --git a/docs/Options.md b/docs/Options.md deleted file mode 100644 index e44ab9f..0000000 --- a/docs/Options.md +++ /dev/null @@ -1,133 +0,0 @@ ---- -title: Client options -nav_order: 4 ---- - -## Setting client options - -Each implementation can be configured using client options. There are 2 ways to provide these, either via `[client].SetDefaultOptions([options]);`, or in the constructor of the client. The examples here use the `BinanceClient`, but usage is the same for each client. - -*Set the default options to use for new clients* -```csharp - -BinanceClient.SetDefaultOptions(options => -{ - options.OutputOriginalData = true; - options.ApiCredentials = new ApiCredentials("KEY", "SECRET"); - // Override the api credentials for the Spot API - options.SpotOptions.ApiCredentials = new ApiCredentials("SPOT-KEY", "SPOT-SECRET"); -}); - -``` - -*Set the options to use for a single new client* -```csharp - -var client = new BinanceClient(options => -{ - options.OutputOriginalData = true; - options.ApiCredentials = new ApiCredentials("KEY", "SECRET"); - // Override the api credentials for the Spot API - options.SpotOptions.ApiCredentials = new ApiCredentials("SPOT-KEY", "SPOT-SECRET"); -}); - -``` - -When calling `SetDefaultOptions` each client created after that will use the options that were set, unless the specific option is overriden in the options that were provided to the client. Consider the following example: -```csharp - -BinanceClient.SetDefaultOptions(options => -{ - options.OutputOriginalData = true; -}); - -var client = new BinanceClient(options => -{ - options.OutputOriginalData = false; -}); - -``` - -The client instance will have the following options: -`OutputOriginalData = false` - -## Api options -The options are divided in two categories. The basic options, which will apply to everything the client does, and the Api options, which is limited to the specific API client (see [Clients](https://jkorf.github.io/CryptoExchange.Net/Clients.html)). - -```csharp - -var client = new BinanceRestClient(options => -{ - options.ApiCredentials = new ApiCredentials("GENERAL-KEY", "GENERAL-SECRET"), - options.SpotOptions.ApiCredentials = new ApiCredentials("SPOT-KEY", "SPOT-SECRET"); -}); - -``` - -The options provided in the SpotApiOptions are only applied to the SpotApi (`client.SpotApi.XXX` endpoints), while the base options are applied to everything. This means that the spot endpoints will use the "SPOT-KEY" credentials, while all other endpoints (`client.UsdFuturesApi.XXX` / `client.CoinFuturesApi.XXX`) will use the "GENERAL-KEY" credentials. - -## CryptoExchange.Net options definitions -All clients have access to the following options, specific implementations might have additional options. - -**Base client options** - -|Option|Description|Default| -|------|-----------|-------| -|`OutputOriginalData`|If set to `true` the originally received Json data will be output as well as the deserialized object. For `RestClient` calls the data will be in the `WebCallResult.OriginalData` property, for `SocketClient` subscriptions the data will be available in the `DataEvent.OriginalData` property when receiving an update. | `false` -|`ApiCredentials`| The API credentials to use for accessing protected endpoints. Can either be an API key/secret using Hmac encryption or an API key/private key using RSA encryption for exchanges that support that. See [Credentials](#credentials). Note that this is a `default` value for all API clients, and can be overridden per API client. See the `Base Api client options`| `null` -|`Proxy`|The proxy to use for connecting to the API.| `null` -|`RequestTimeout`|The timeout for client requests to the server| `TimeSpan.FromSeconds(20)` - -**Rest client options (extension of base client options)** - -|Option|Description|Default| -|------|-----------|-------| -|`AutoTimestamp`|Whether or not the library should attempt to sync the time between the client and server. If the time between server and client is not in sync authentication errors might occur. This option should be disabled when the client time sure is to be in sync.|`true`| -|`TimestampRecalculationInterval`|The interval of how often the time synchronization between client and server should be executed| `TimeSpan.FromHours(1)` -|`Environment`|The environment the library should talk to. Some exchanges have testnet/sandbox environments which can be used instead of the real exchange. The environment option can be used to switch between different trade environments|`Live environment` - -**Socket client options (extension of base client options)** - -|Option|Description|Default| -|------|-----------|-------| -|`AutoReconnect`|Whether or not the socket should attempt to automatically reconnect when disconnected.|`true` -|`ReconnectInterval`|The time to wait between connection tries when reconnecting.|`TimeSpan.FromSeconds(5)` -|`SocketResponseTimeout`|The time in which a response is expected on a request before giving a timeout.|`TimeSpan.FromSeconds(10)` -|`SocketNoDataTimeout`|If no data is received after this timespan then assume the connection is dropped. This is mainly used for API's which have some sort of ping/keepalive system. For example; the Bitfinex API will sent a heartbeat message every 15 seconds, so the `SocketNoDataTimeout` could be set to 20 seconds. On API's without such a mechanism this might not work because there just might not be any update while still being fully connected. | `default(TimeSpan)` (no timeout) -|`SocketSubscriptionsCombineTarget`|The amount of subscriptions that should be made on a single socket connection. Not all exchanges support multiple subscriptions on a single socket. Setting this to a higher number increases subscription speed because not every subscription needs to connect to the server, but having more subscriptions on a single connection will also increase the amount of traffic on that single connection, potentially leading to issues.| Depends on implementation -|`MaxConcurrentResubscriptionsPerSocket`|The maximum number of concurrent resubscriptions per socket when resubscribing after reconnecting|5 -|`MaxSocketConnections`|The maximum amount of distinct socket connections|`null` -|`DelayAfterConnect`|The time to wait before sending messages after connecting to the server.|`TimeSpan.Zero` -|`Environment`|The environment the library should talk to. Some exchanges have testnet/sandbox environments which can be used instead of the real exchange. The environment option can be used to switch between different trade environments|`Live environment` - -**Base Api client options** - -|Option|Description|Default| -|------|-----------|-------| -|`ApiCredentials`|The API credentials to use for accessing protected endpoints. Can either be an API key/secret using Hmac encryption or an API key/private key using RSA encryption for exchanges that support that. See [Credentials](#credentials). Setting ApiCredentials on the Api Options will override any default ApiCredentials on the `Base client options`| `null` -|`OutputOriginalData`|If set to `true` the originally received Json data will be output as well as the deserialized object. For `RestClient` calls the data will be in the `WebCallResult.OriginalData` property, for `SocketClient` subscriptions the data will be available in the `DataEvent.OriginalData` property when receiving an update.|False - -**Options for Rest Api Client (extension of base api client options)** - -|Option|Description|Default| -|------|-----------|-------| -|`RateLimiters`|A list of `IRateLimiter`s to use.|`new List()`| -|`RateLimitingBehaviour`|What should happen when a rate limit is reached.|`RateLimitingBehaviour.Wait`| -|`AutoTimestamp`|Whether or not the library should attempt to sync the time between the client and server. If the time between server and client is not in sync authentication errors might occur. This option should be disabled when the client time is sure to be in sync. Overrides the Rest client options `AutoTimestamp` option if set|`null`| -|`TimestampRecalculationInterval`|The interval of how often the time synchronization between client and server should be executed. Overrides the Rest client options `TimestampRecalculationInterval` option if set| `TimeSpan.FromHours(1)` - -**Options for Socket Api Client (extension of base api client options)** - -|Option|Description|Default| -|------|-----------|-------| -|`SocketNoDataTimeout`|If no data is received after this timespan then assume the connection is dropped. This is mainly used for API's which have some sort of ping/keepalive system. For example; the Bitfinex API will sent a heartbeat message every 15 seconds, so the `SocketNoDataTimeout` could be set to 20 seconds. On API's without such a mechanism this might not work because there just might not be any update while still being fully connected. Overrides the Socket client options `SocketNoDataTimeout` option if set | `default(TimeSpan)` (no timeout) -|`MaxSocketConnections`|The maximum amount of distinct socket connections. Overrides the Socket client options `MaxSocketConnections` option if set |`null` - -## Credentials -Credentials are supported in 3 formats in the base library: - -|Type|Description|Example| -|----|-----------|-------| -|`Hmac`|An API key + secret combination. The API key is send with the request and the secret is used to sign requests. This is the default authentication method on all exchanges. |`options.ApiCredentials = new ApiCredentials("51231f76e-9c503548-8fabs3f-rfgf12mkl3", "556be32-d563ba53-faa2dfd-b3n5c", CredentialType.Hmac);`| -|`RsaPem`|An API key + a public and private key pair generated by the user. The public key is shared with the exchange, while the private key is used to sign requests. This CredentialType expects the private key to be in .pem format and is only supported in .netstandard2.1 due to limitations of the framework|`options.ApiCredentials = new ApiCredentials("432vpV8daAaXAF4Qg", ""-----BEGIN PRIVATE KEY-----[PRIVATEKEY]-----END PRIVATE KEY-----", CredentialType.RsaPem);`| -|`RsaXml`|An API key + a public and private key pair generated by the user. The public key is shared with the exchange, while the private key is used to sign requests. This CredentialType expects the private key to be in xml format and is supported in .netstandard2.0 and .netstandard2.1, but it might mean the private key needs to be converted from the original format to xml|`options.ApiCredentials = new ApiCredentials("432vpV8daAaXAF4Qg", "[PRIVATEKEY]", CredentialType.RsaXml);`| \ No newline at end of file diff --git a/docs/Orderbooks.md b/docs/Orderbooks.md deleted file mode 100644 index a529bc9..0000000 --- a/docs/Orderbooks.md +++ /dev/null @@ -1,68 +0,0 @@ ---- -title: Order books -nav_order: 6 ---- - -## Locally synced order book -Each exchange implementation provides an order book implementation. These implementations will provide a client side order book and will take care of synchronization with the server, and will handle reconnecting and resynchronizing in case of a dropped connection. -Order book implementations are named as `[ExchangeName][Type]SymbolOrderBook`, for example `BinanceSpotSymbolOrderBook`. - -## Usage -Start the book synchronization by calling the `StartAsync` method. This returns whether the book is successfully synchronized and started. You can listen to the `OnStatusChange` event to be notified of when the status of a book changes. Note that the order book is only synchronized with the server when the state is `Synced`. When the order book has been started and the state changes from `Synced` to `Reconnecting` the book will automatically reconnect and resync itself. - -*Start an order book and print the top 3 rows* -```csharp - -var book = new BinanceSpotSymbolOrderBook("BTCUSDT"); -book.OnStatusChange += (oldState, newState) => Console.WriteLine($"State changed from {oldState} to {newState}"); -var startResult = await book.StartAsync(); -if (!startResult.Success) -{ - Console.WriteLine("Failed to start order book: " + startResult.Error); - return; -} - -while(true) -{ - Console.Clear(); - Console.WriteLine(book.ToString(3); - await Task.Delay(500); -} - -``` - -### Accessing bids/asks -You can access the current Bid/Ask lists using the responding properties: -`var currentBidList = book.Bids;` -`var currentAskList = book.Asks;` - -Note that these will return copies of the internally synced lists when accessing the properties, and when accessing them in sequence like above does mean that the lists may not be in sync with eachother since they're accessed at different points in time. -When you need both lists in sync you should access the `Book` property. -`var (currentBidList, currentAskList) = book.Book;` - -Because copies of the lists are made when accessing the bids/asks properties the performance impact should be considered. When only the current best ask/bid info is needed you can access the `BestOffers` property. -`var (bestBid, bestAsk) = book.BestOffers;` - -### Events -The following events are available on the symbol order book: -`book.OnStatusChange`: The book has changed state. This happens during connecting, the connection was lost or the order book was detected to be out of sync. The asks/bids are only the actual with the server when state is `Synced`. -`book.OnOrderBookUpdate`: The book has changed, the arguments contain the changed entries. -`book.OnBestOffersChanged`: The best offer (best bid, best ask) has changed. - -```csharp - -book.OnStatusChange += (oldStatus, newStatus) => { Console.WriteLine($"State changed from {oldStatus} to {newStatus}"); }; -book.OnOrderBookUpdate += (bidsAsks) => { Console.WriteLine($"Order book changed: {bidsAsks.Asks.Count()} asks, {bidsAsks.Bids.Count()} bids"); }; -book.OnBestOffersChanged += (bestOffer) => { Console.WriteLine($"Best offer changed, best bid: {bestOffer.BestBid.Price}, best ask: {bestOffer.BestAsk.Price}"); }; - -``` - -### Order book factory - Each exchange implementation also provides an order book factory for creating ISymbolOrderBook instances. The naming convention for the factory is `[Exchange]OrderBookFactory`, for example `BinanceOrderBookFactory`. This type will be automatically added when using DI and can be used to facilitate easier testing. - - *Creating an order book using the order book factory* - ```csharp -var factory = services.GetRequiredService(); -var book = factory.CreateSpot("ETH-USDT"); -var startResult = await book.StartAsync(); - ``` \ No newline at end of file diff --git a/docs/RateLimiter.md b/docs/RateLimiter.md deleted file mode 100644 index 7f7f591..0000000 --- a/docs/RateLimiter.md +++ /dev/null @@ -1,74 +0,0 @@ ---- -title: Rate limiting -nav_order: 9 ---- - -## Rate limiting -The library has build in rate limiting. These rate limits can be configured per client. Some client implementations where the exchange has clear rate limits will also have a default rate limiter already set up. -Rate limiting is configured in the client options, and can be set on a specific client or for all clients by either providing it in the constructor for a client, or by using the `SetDefaultOptions` on a client. - -What to do when a limit is reached can be configured with the `RateLimitingBehaviour` client options, which has 2 possible options. Setting it to `Fail` will cause a request to fail without sending it. Setting it to `Wait` will cause the request to wait until the request can be send in accordance to the rate limiter. - -A rate limiter can be configured in the options like so: -```csharp -new ClientOptions -{ - RateLimitingBehaviour = RateLimitingBehaviour.Wait, - RateLimiters = new List - { - new RateLimiter() - .AddTotalRateLimit(50, TimeSpan.FromSeconds(10)) - } -} -``` - -This will add a rate limiter for 50 requests per 10 seconds. -A rate limiter can have multiple limits: -```csharp -new RateLimiter() - .AddTotalRateLimit(50, TimeSpan.FromSeconds(10)) - .AddEndpointLimit("/api/order", 10, TimeSpan.FromSeconds(2)) -``` -This adds another limit of 10 requests per 2 seconds in addition to the 50 requests per 10 seconds limit. -These are the available rate limit configurations: - -### AddTotalRateLimit -|Parameter|Description| -|---------|-----------| -|limit|The request weight limit per time period. Note that requests can have a weight specified. Default requests will have a weight of 1| -|perTimePeriod|The time period over which the limit is enforced| - -A rate limit for the total amount of requests for all requests send from the client. - -### AddEndpointLimit -|Parameter|Description| -|---------|-----------| -|endpoint|The endpoint this limit is for| -|limit|The request weight limit per time period. Note that requests can have a weight specified. Default requests will have a weight of 1| -|perTimePeriod|The time period over which the limit is enforced| -|method|The HTTP method this limit is for. Defaults to all methods| -|excludeFromOtherRateLimits|When set to true requests to this endpoint won't be counted for other configured rate limits| - -A rate limit for all requests send to a specific endpoint. Requests that do not fully match the endpoint will not be counted to this limit. - -### AddPartialEndpointLimit -|Parameter|Description| -|---------|-----------| -|endpoint|The partial endpoint this limit is for. Partial means that a request will match this limiter when a part of the request URI path matches this endpoint| -|limit|The request weight limit per time period. Note that requests can have a weight specified. Default requests will have a weight of 1| -|perTimePeriod|The time period over which the limit is enforced| -|method|The HTTP method this limit is for. Defaults to all methods| -|countPerEndpoint|Whether all requests matching the endpoint pattern should be combined for this limit or each endpoint has its own limit| -|ignoreOtherRateLimits|When set to true requests to this endpoint won't be counted for other configured rate limits| - -A rate limit for a partial endpoint. Requests will be counted towards this limit if the request path contains the endpoint. For example request `/api/v2/test` will match when the partial endpoint limit is set for `/api/v2`. - -### AddApiKeyLimit -|Parameter|Description| -|---------|-----------| -|limit|The request weight limit per time period. Note that requests can have a weight specified. Default requests will have a weight of 1| -|perTimePeriod|The time period over which the limit is enforced| -|onlyForSignedRequests|Whether this rate limit should only be counter for signed/authenticated requests| -|excludeFromTotalRateLimit|Whether requests counted for this rate limited should not be counted towards the total rate limit| - -A rate limit for an API key. Requests with the same API key will be grouped and limited. \ No newline at end of file diff --git a/docs/assets/css/color-blue.css b/docs/assets/css/color-blue.css new file mode 100644 index 0000000..1caa28d --- /dev/null +++ b/docs/assets/css/color-blue.css @@ -0,0 +1,159 @@ +/*============================ + COLOR Blue +==============================*/ +::selection { + background: #007bff; +} + +a, a:focus { + color: #007bff; +} + +a:hover, a:active { + color: #006adb; +} + +.primary-menu ul.navbar-nav > li:hover > a:not(.btn), .primary-menu ul.navbar-nav > li > a.active:not(.btn) { + color: #007bff; +} +.primary-menu ul.navbar-nav > li.dropdown .dropdown-menu li:hover > a:not(.btn) { + color: #007bff; +} +.primary-menu.navbar-line-under-text ul.navbar-nav > li > a:not(.btn):after { + border-color: #007bff; +} + +/*=== Side Navigation ===*/ +.idocs-navigation .nav .nav .nav-item .nav-link.active:after, .idocs-navigation.docs-navigation-dark .nav .nav .nav-item .nav-link.active:after { + border-color: #007bff; +} + +/* Accordion & Toggle */ +.accordion .card-header a:hover.collapsed { + color: #007bff !important; +} +.accordion:not(.accordion-alternate) .card-header a { + background-color: #007bff; + color: #fff; +} + +/* Nav */ +.nav:not(.nav-pills) .nav-item .nav-link.active, .nav:not(.nav-pills) .nav-item .nav-link:hover { + color: #007bff; +} + +.nav-tabs .nav-item .nav-link.active { + color: #0c2f55; +} +.nav-tabs .nav-item .nav-link.active:after { + background-color: #007bff; +} +.nav-tabs .nav-item .nav-link:not(.active):hover { + color: #007bff; +} +.nav-tabs.flex-column .nav-item .nav-link.active { + color: #007bff; +} + +.nav-pills .nav-link:not(.active):hover { + color: #007bff; +} + +#footer .nav .nav-item .nav-link:focus { + color: #007bff; +} +#footer .nav .nav-link:hover { + color: #007bff; +} +#footer .footer-copyright .nav .nav-link:hover { + color: #007bff; +} + +/* Back to Top */ +#back-to-top:hover { + background-color: #007bff; +} + +/* Extras */ +.bg-primary, .badge-primary { + background-color: #007bff !important; +} + +.text-primary, .btn-light, .btn-outline-light:hover, .btn-link, .btn-outline-light:not(:disabled):not(.disabled).active, .btn-outline-light:not(:disabled):not(.disabled):active { + color: #007bff !important; +} + +.btn-link:hover { + color: #006adb !important; +} + +.text-muted { + color: #8e9a9d !important; +} + +.text-light { + color: #dee3e4 !important; +} + +a.bg-primary:focus, a.bg-primary:hover, button.bg-primary:focus, button.bg-primary:hover { + background-color: #006adb !important; +} + +.border-primary { + border-color: #007bff !important; +} + +.btn-primary { + background-color: #007bff; + border-color: #007bff; +} +.btn-primary:hover { + background-color: #006adb; + border-color: #006adb; +} + +.btn-primary:not(:disabled):not(.disabled).active, .btn-primary:not(:disabled):not(.disabled):active { + background-color: #006adb; + border-color: #006adb; +} + +.btn-primary.focus, .btn-primary:focus { + background-color: #006adb; + border-color: #006adb; +} + +.btn-outline-primary, .btn-outline-primary:not(:disabled):not(.disabled).active, .btn-outline-primary:not(:disabled):not(.disabled):active { + color: #007bff; + border-color: #007bff; +} +.btn-outline-primary:hover, .btn-outline-primary:not(:disabled):not(.disabled).active:hover, .btn-outline-primary:not(:disabled):not(.disabled):active:hover { + background-color: #007bff; + border-color: #007bff; + color: #fff; +} + +.progress-bar, +.nav-pills .nav-link.active, .nav-pills .show > .nav-link, .dropdown-item.active, .dropdown-item:active { + background-color: #007bff; +} + +.page-item.active .page-link, +.custom-radio .custom-control-input:checked ~ .custom-control-label:before, +.custom-control-input:checked ~ .custom-control-label::before, +.custom-checkbox .custom-control-input:checked ~ .custom-control-label:before, +.custom-control-input:checked ~ .custom-control-label:before { + background-color: #007bff; + border-color: #007bff; +} + +.list-group-item.active { + background-color: #007bff; + border-color: #007bff; +} + +.page-link { + color: #007bff; +} +.page-link:hover { + color: #006adb; +} diff --git a/docs/assets/css/color-brown.css b/docs/assets/css/color-brown.css new file mode 100644 index 0000000..4fbb38c --- /dev/null +++ b/docs/assets/css/color-brown.css @@ -0,0 +1,159 @@ +/*============================ + COLOR Brown +==============================*/ +::selection { + background: #795548; +} + +a, a:focus { + color: #795548; +} + +a:hover, a:active { + color: #63453b; +} + +.primary-menu ul.navbar-nav > li:hover > a:not(.btn), .primary-menu ul.navbar-nav > li > a.active:not(.btn) { + color: #795548; +} +.primary-menu ul.navbar-nav > li.dropdown .dropdown-menu li:hover > a:not(.btn) { + color: #795548; +} +.primary-menu.navbar-line-under-text ul.navbar-nav > li > a:not(.btn):after { + border-color: #795548; +} + +/*=== Side Navigation ===*/ +.idocs-navigation .nav .nav .nav-item .nav-link.active:after, .idocs-navigation.docs-navigation-dark .nav .nav .nav-item .nav-link.active:after { + border-color: #795548; +} + +/* Accordion & Toggle */ +.accordion .card-header a:hover.collapsed { + color: #795548 !important; +} +.accordion:not(.accordion-alternate) .card-header a { + background-color: #795548; + color: #fff; +} + +/* Nav */ +.nav:not(.nav-pills) .nav-item .nav-link.active, .nav:not(.nav-pills) .nav-item .nav-link:hover { + color: #795548; +} + +.nav-tabs .nav-item .nav-link.active { + color: #0c2f55; +} +.nav-tabs .nav-item .nav-link.active:after { + background-color: #795548; +} +.nav-tabs .nav-item .nav-link:not(.active):hover { + color: #795548; +} +.nav-tabs.flex-column .nav-item .nav-link.active { + color: #795548; +} + +.nav-pills .nav-link:not(.active):hover { + color: #795548; +} + +#footer .nav .nav-item .nav-link:focus { + color: #795548; +} +#footer .nav .nav-link:hover { + color: #795548; +} +#footer .footer-copyright .nav .nav-link:hover { + color: #795548; +} + +/* Back to Top */ +#back-to-top:hover { + background-color: #795548; +} + +/* Extras */ +.bg-primary, .badge-primary { + background-color: #795548 !important; +} + +.text-primary, .btn-light, .btn-outline-light:hover, .btn-link, .btn-outline-light:not(:disabled):not(.disabled).active, .btn-outline-light:not(:disabled):not(.disabled):active { + color: #795548 !important; +} + +.btn-link:hover { + color: #63453b !important; +} + +.text-muted { + color: #8e9a9d !important; +} + +.text-light { + color: #dee3e4 !important; +} + +a.bg-primary:focus, a.bg-primary:hover, button.bg-primary:focus, button.bg-primary:hover { + background-color: #63453b !important; +} + +.border-primary { + border-color: #795548 !important; +} + +.btn-primary { + background-color: #795548; + border-color: #795548; +} +.btn-primary:hover { + background-color: #63453b; + border-color: #63453b; +} + +.btn-primary:not(:disabled):not(.disabled).active, .btn-primary:not(:disabled):not(.disabled):active { + background-color: #63453b; + border-color: #63453b; +} + +.btn-primary.focus, .btn-primary:focus { + background-color: #63453b; + border-color: #63453b; +} + +.btn-outline-primary, .btn-outline-primary:not(:disabled):not(.disabled).active, .btn-outline-primary:not(:disabled):not(.disabled):active { + color: #795548; + border-color: #795548; +} +.btn-outline-primary:hover, .btn-outline-primary:not(:disabled):not(.disabled).active:hover, .btn-outline-primary:not(:disabled):not(.disabled):active:hover { + background-color: #795548; + border-color: #795548; + color: #fff; +} + +.progress-bar, +.nav-pills .nav-link.active, .nav-pills .show > .nav-link, .dropdown-item.active, .dropdown-item:active { + background-color: #795548; +} + +.page-item.active .page-link, +.custom-radio .custom-control-input:checked ~ .custom-control-label:before, +.custom-control-input:checked ~ .custom-control-label::before, +.custom-checkbox .custom-control-input:checked ~ .custom-control-label:before, +.custom-control-input:checked ~ .custom-control-label:before { + background-color: #795548; + border-color: #795548; +} + +.list-group-item.active { + background-color: #795548; + border-color: #795548; +} + +.page-link { + color: #795548; +} +.page-link:hover { + color: #63453b; +} diff --git a/docs/assets/css/color-cyan.css b/docs/assets/css/color-cyan.css new file mode 100644 index 0000000..fa712d8 --- /dev/null +++ b/docs/assets/css/color-cyan.css @@ -0,0 +1,159 @@ +/*============================ + COLOR Cyan +==============================*/ +::selection { + background: #17a2b8; +} + +a, a:focus { + color: #17a2b8; +} + +a:hover, a:active { + color: #138698; +} + +.primary-menu ul.navbar-nav > li:hover > a:not(.btn), .primary-menu ul.navbar-nav > li > a.active:not(.btn) { + color: #17a2b8; +} +.primary-menu ul.navbar-nav > li.dropdown .dropdown-menu li:hover > a:not(.btn) { + color: #17a2b8; +} +.primary-menu.navbar-line-under-text ul.navbar-nav > li > a:not(.btn):after { + border-color: #17a2b8; +} + +/*=== Side Navigation ===*/ +.idocs-navigation .nav .nav .nav-item .nav-link.active:after, .idocs-navigation.docs-navigation-dark .nav .nav .nav-item .nav-link.active:after { + border-color: #17a2b8; +} + +/* Accordion & Toggle */ +.accordion .card-header a:hover.collapsed { + color: #17a2b8 !important; +} +.accordion:not(.accordion-alternate) .card-header a { + background-color: #17a2b8; + color: #fff; +} + +/* Nav */ +.nav:not(.nav-pills) .nav-item .nav-link.active, .nav:not(.nav-pills) .nav-item .nav-link:hover { + color: #17a2b8; +} + +.nav-tabs .nav-item .nav-link.active { + color: #0c2f55; +} +.nav-tabs .nav-item .nav-link.active:after { + background-color: #17a2b8; +} +.nav-tabs .nav-item .nav-link:not(.active):hover { + color: #17a2b8; +} +.nav-tabs.flex-column .nav-item .nav-link.active { + color: #17a2b8; +} + +.nav-pills .nav-link:not(.active):hover { + color: #17a2b8; +} + +#footer .nav .nav-item .nav-link:focus { + color: #17a2b8; +} +#footer .nav .nav-link:hover { + color: #17a2b8; +} +#footer .footer-copyright .nav .nav-link:hover { + color: #17a2b8; +} + +/* Back to Top */ +#back-to-top:hover { + background-color: #17a2b8; +} + +/* Extras */ +.bg-primary, .badge-primary { + background-color: #17a2b8 !important; +} + +.text-primary, .btn-light, .btn-outline-light:hover, .btn-link, .btn-outline-light:not(:disabled):not(.disabled).active, .btn-outline-light:not(:disabled):not(.disabled):active { + color: #17a2b8 !important; +} + +.btn-link:hover { + color: #138698 !important; +} + +.text-muted { + color: #8e9a9d !important; +} + +.text-light { + color: #dee3e4 !important; +} + +a.bg-primary:focus, a.bg-primary:hover, button.bg-primary:focus, button.bg-primary:hover { + background-color: #138698 !important; +} + +.border-primary { + border-color: #17a2b8 !important; +} + +.btn-primary { + background-color: #17a2b8; + border-color: #17a2b8; +} +.btn-primary:hover { + background-color: #138698; + border-color: #138698; +} + +.btn-primary:not(:disabled):not(.disabled).active, .btn-primary:not(:disabled):not(.disabled):active { + background-color: #138698; + border-color: #138698; +} + +.btn-primary.focus, .btn-primary:focus { + background-color: #138698; + border-color: #138698; +} + +.btn-outline-primary, .btn-outline-primary:not(:disabled):not(.disabled).active, .btn-outline-primary:not(:disabled):not(.disabled):active { + color: #17a2b8; + border-color: #17a2b8; +} +.btn-outline-primary:hover, .btn-outline-primary:not(:disabled):not(.disabled).active:hover, .btn-outline-primary:not(:disabled):not(.disabled):active:hover { + background-color: #17a2b8; + border-color: #17a2b8; + color: #fff; +} + +.progress-bar, +.nav-pills .nav-link.active, .nav-pills .show > .nav-link, .dropdown-item.active, .dropdown-item:active { + background-color: #17a2b8; +} + +.page-item.active .page-link, +.custom-radio .custom-control-input:checked ~ .custom-control-label:before, +.custom-control-input:checked ~ .custom-control-label::before, +.custom-checkbox .custom-control-input:checked ~ .custom-control-label:before, +.custom-control-input:checked ~ .custom-control-label:before { + background-color: #17a2b8; + border-color: #17a2b8; +} + +.list-group-item.active { + background-color: #17a2b8; + border-color: #17a2b8; +} + +.page-link { + color: #17a2b8; +} +.page-link:hover { + color: #138698; +} diff --git a/docs/assets/css/color-green.css b/docs/assets/css/color-green.css new file mode 100644 index 0000000..4810d8b --- /dev/null +++ b/docs/assets/css/color-green.css @@ -0,0 +1,159 @@ +/*============================ + COLOR Green +==============================*/ +::selection { + background: #28a745; +} + +a, a:focus { + color: #28a745; +} + +a:hover, a:active { + color: #218a39; +} + +.primary-menu ul.navbar-nav > li:hover > a:not(.btn), .primary-menu ul.navbar-nav > li > a.active:not(.btn) { + color: #28a745; +} +.primary-menu ul.navbar-nav > li.dropdown .dropdown-menu li:hover > a:not(.btn) { + color: #28a745; +} +.primary-menu.navbar-line-under-text ul.navbar-nav > li > a:not(.btn):after { + border-color: #28a745; +} + +/*=== Side Navigation ===*/ +.idocs-navigation .nav .nav .nav-item .nav-link.active:after, .idocs-navigation.docs-navigation-dark .nav .nav .nav-item .nav-link.active:after { + border-color: #28a745; +} + +/* Accordion & Toggle */ +.accordion .card-header a:hover.collapsed { + color: #28a745 !important; +} +.accordion:not(.accordion-alternate) .card-header a { + background-color: #28a745; + color: #fff; +} + +/* Nav */ +.nav:not(.nav-pills) .nav-item .nav-link.active, .nav:not(.nav-pills) .nav-item .nav-link:hover { + color: #28a745; +} + +.nav-tabs .nav-item .nav-link.active { + color: #0c2f55; +} +.nav-tabs .nav-item .nav-link.active:after { + background-color: #28a745; +} +.nav-tabs .nav-item .nav-link:not(.active):hover { + color: #28a745; +} +.nav-tabs.flex-column .nav-item .nav-link.active { + color: #28a745; +} + +.nav-pills .nav-link:not(.active):hover { + color: #28a745; +} + +#footer .nav .nav-item .nav-link:focus { + color: #28a745; +} +#footer .nav .nav-link:hover { + color: #28a745; +} +#footer .footer-copyright .nav .nav-link:hover { + color: #28a745; +} + +/* Back to Top */ +#back-to-top:hover { + background-color: #28a745; +} + +/* Extras */ +.bg-primary, .badge-primary { + background-color: #28a745 !important; +} + +.text-primary, .btn-light, .btn-outline-light:hover, .btn-link, .btn-outline-light:not(:disabled):not(.disabled).active, .btn-outline-light:not(:disabled):not(.disabled):active { + color: #28a745 !important; +} + +.btn-link:hover { + color: #218a39 !important; +} + +.text-muted { + color: #8e9a9d !important; +} + +.text-light { + color: #dee3e4 !important; +} + +a.bg-primary:focus, a.bg-primary:hover, button.bg-primary:focus, button.bg-primary:hover { + background-color: #218a39 !important; +} + +.border-primary { + border-color: #28a745 !important; +} + +.btn-primary { + background-color: #28a745; + border-color: #28a745; +} +.btn-primary:hover { + background-color: #218a39; + border-color: #218a39; +} + +.btn-primary:not(:disabled):not(.disabled).active, .btn-primary:not(:disabled):not(.disabled):active { + background-color: #218a39; + border-color: #218a39; +} + +.btn-primary.focus, .btn-primary:focus { + background-color: #218a39; + border-color: #218a39; +} + +.btn-outline-primary, .btn-outline-primary:not(:disabled):not(.disabled).active, .btn-outline-primary:not(:disabled):not(.disabled):active { + color: #28a745; + border-color: #28a745; +} +.btn-outline-primary:hover, .btn-outline-primary:not(:disabled):not(.disabled).active:hover, .btn-outline-primary:not(:disabled):not(.disabled):active:hover { + background-color: #28a745; + border-color: #28a745; + color: #fff; +} + +.progress-bar, +.nav-pills .nav-link.active, .nav-pills .show > .nav-link, .dropdown-item.active, .dropdown-item:active { + background-color: #28a745; +} + +.page-item.active .page-link, +.custom-radio .custom-control-input:checked ~ .custom-control-label:before, +.custom-control-input:checked ~ .custom-control-label::before, +.custom-checkbox .custom-control-input:checked ~ .custom-control-label:before, +.custom-control-input:checked ~ .custom-control-label:before { + background-color: #28a745; + border-color: #28a745; +} + +.list-group-item.active { + background-color: #28a745; + border-color: #28a745; +} + +.page-link { + color: #28a745; +} +.page-link:hover { + color: #218a39; +} diff --git a/docs/assets/css/color-indigo.css b/docs/assets/css/color-indigo.css new file mode 100644 index 0000000..f9141bd --- /dev/null +++ b/docs/assets/css/color-indigo.css @@ -0,0 +1,159 @@ +/*============================ + COLOR Indigo +==============================*/ +::selection { + background: #6610f2; +} + +a, a:focus { + color: #6610f2; +} + +a:hover, a:active { + color: #570bd3; +} + +.primary-menu ul.navbar-nav > li:hover > a:not(.btn), .primary-menu ul.navbar-nav > li > a.active:not(.btn) { + color: #6610f2; +} +.primary-menu ul.navbar-nav > li.dropdown .dropdown-menu li:hover > a:not(.btn) { + color: #6610f2; +} +.primary-menu.navbar-line-under-text ul.navbar-nav > li > a:not(.btn):after { + border-color: #6610f2; +} + +/*=== Side Navigation ===*/ +.idocs-navigation .nav .nav .nav-item .nav-link.active:after, .idocs-navigation.docs-navigation-dark .nav .nav .nav-item .nav-link.active:after { + border-color: #6610f2; +} + +/* Accordion & Toggle */ +.accordion .card-header a:hover.collapsed { + color: #6610f2 !important; +} +.accordion:not(.accordion-alternate) .card-header a { + background-color: #6610f2; + color: #fff; +} + +/* Nav */ +.nav:not(.nav-pills) .nav-item .nav-link.active, .nav:not(.nav-pills) .nav-item .nav-link:hover { + color: #6610f2; +} + +.nav-tabs .nav-item .nav-link.active { + color: #0c2f55; +} +.nav-tabs .nav-item .nav-link.active:after { + background-color: #6610f2; +} +.nav-tabs .nav-item .nav-link:not(.active):hover { + color: #6610f2; +} +.nav-tabs.flex-column .nav-item .nav-link.active { + color: #6610f2; +} + +.nav-pills .nav-link:not(.active):hover { + color: #6610f2; +} + +#footer .nav .nav-item .nav-link:focus { + color: #6610f2; +} +#footer .nav .nav-link:hover { + color: #6610f2; +} +#footer .footer-copyright .nav .nav-link:hover { + color: #6610f2; +} + +/* Back to Top */ +#back-to-top:hover { + background-color: #6610f2; +} + +/* Extras */ +.bg-primary, .badge-primary { + background-color: #6610f2 !important; +} + +.text-primary, .btn-light, .btn-outline-light:hover, .btn-link, .btn-outline-light:not(:disabled):not(.disabled).active, .btn-outline-light:not(:disabled):not(.disabled):active { + color: #6610f2 !important; +} + +.btn-link:hover { + color: #570bd3 !important; +} + +.text-muted { + color: #8e9a9d !important; +} + +.text-light { + color: #dee3e4 !important; +} + +a.bg-primary:focus, a.bg-primary:hover, button.bg-primary:focus, button.bg-primary:hover { + background-color: #570bd3 !important; +} + +.border-primary { + border-color: #6610f2 !important; +} + +.btn-primary { + background-color: #6610f2; + border-color: #6610f2; +} +.btn-primary:hover { + background-color: #570bd3; + border-color: #570bd3; +} + +.btn-primary:not(:disabled):not(.disabled).active, .btn-primary:not(:disabled):not(.disabled):active { + background-color: #570bd3; + border-color: #570bd3; +} + +.btn-primary.focus, .btn-primary:focus { + background-color: #570bd3; + border-color: #570bd3; +} + +.btn-outline-primary, .btn-outline-primary:not(:disabled):not(.disabled).active, .btn-outline-primary:not(:disabled):not(.disabled):active { + color: #6610f2; + border-color: #6610f2; +} +.btn-outline-primary:hover, .btn-outline-primary:not(:disabled):not(.disabled).active:hover, .btn-outline-primary:not(:disabled):not(.disabled):active:hover { + background-color: #6610f2; + border-color: #6610f2; + color: #fff; +} + +.progress-bar, +.nav-pills .nav-link.active, .nav-pills .show > .nav-link, .dropdown-item.active, .dropdown-item:active { + background-color: #6610f2; +} + +.page-item.active .page-link, +.custom-radio .custom-control-input:checked ~ .custom-control-label:before, +.custom-control-input:checked ~ .custom-control-label::before, +.custom-checkbox .custom-control-input:checked ~ .custom-control-label:before, +.custom-control-input:checked ~ .custom-control-label:before { + background-color: #6610f2; + border-color: #6610f2; +} + +.list-group-item.active { + background-color: #6610f2; + border-color: #6610f2; +} + +.page-link { + color: #6610f2; +} +.page-link:hover { + color: #570bd3; +} diff --git a/docs/assets/css/color-orange.css b/docs/assets/css/color-orange.css new file mode 100644 index 0000000..d7cda6b --- /dev/null +++ b/docs/assets/css/color-orange.css @@ -0,0 +1,159 @@ +/*============================ + COLOR Orange +==============================*/ +::selection { + background: #fd7e14; +} + +a, a:focus { + color: #fd7e14; +} + +a:hover, a:active { + color: #eb6c02; +} + +.primary-menu ul.navbar-nav > li:hover > a:not(.btn), .primary-menu ul.navbar-nav > li > a.active:not(.btn) { + color: #fd7e14; +} +.primary-menu ul.navbar-nav > li.dropdown .dropdown-menu li:hover > a:not(.btn) { + color: #fd7e14; +} +.primary-menu.navbar-line-under-text ul.navbar-nav > li > a:not(.btn):after { + border-color: #fd7e14; +} + +/*=== Side Navigation ===*/ +.idocs-navigation .nav .nav .nav-item .nav-link.active:after, .idocs-navigation.docs-navigation-dark .nav .nav .nav-item .nav-link.active:after { + border-color: #fd7e14; +} + +/* Accordion & Toggle */ +.accordion .card-header a:hover.collapsed { + color: #fd7e14 !important; +} +.accordion:not(.accordion-alternate) .card-header a { + background-color: #fd7e14; + color: #fff; +} + +/* Nav */ +.nav:not(.nav-pills) .nav-item .nav-link.active, .nav:not(.nav-pills) .nav-item .nav-link:hover { + color: #fd7e14; +} + +.nav-tabs .nav-item .nav-link.active { + color: #0c2f55; +} +.nav-tabs .nav-item .nav-link.active:after { + background-color: #fd7e14; +} +.nav-tabs .nav-item .nav-link:not(.active):hover { + color: #fd7e14; +} +.nav-tabs.flex-column .nav-item .nav-link.active { + color: #fd7e14; +} + +.nav-pills .nav-link:not(.active):hover { + color: #fd7e14; +} + +#footer .nav .nav-item .nav-link:focus { + color: #fd7e14; +} +#footer .nav .nav-link:hover { + color: #fd7e14; +} +#footer .footer-copyright .nav .nav-link:hover { + color: #fd7e14; +} + +/* Back to Top */ +#back-to-top:hover { + background-color: #fd7e14; +} + +/* Extras */ +.bg-primary, .badge-primary { + background-color: #fd7e14 !important; +} + +.text-primary, .btn-light, .btn-outline-light:hover, .btn-link, .btn-outline-light:not(:disabled):not(.disabled).active, .btn-outline-light:not(:disabled):not(.disabled):active { + color: #fd7e14 !important; +} + +.btn-link:hover { + color: #eb6c02 !important; +} + +.text-muted { + color: #8e9a9d !important; +} + +.text-light { + color: #dee3e4 !important; +} + +a.bg-primary:focus, a.bg-primary:hover, button.bg-primary:focus, button.bg-primary:hover { + background-color: #eb6c02 !important; +} + +.border-primary { + border-color: #fd7e14 !important; +} + +.btn-primary { + background-color: #fd7e14; + border-color: #fd7e14; +} +.btn-primary:hover { + background-color: #eb6c02; + border-color: #eb6c02; +} + +.btn-primary:not(:disabled):not(.disabled).active, .btn-primary:not(:disabled):not(.disabled):active { + background-color: #eb6c02; + border-color: #eb6c02; +} + +.btn-primary.focus, .btn-primary:focus { + background-color: #eb6c02; + border-color: #eb6c02; +} + +.btn-outline-primary, .btn-outline-primary:not(:disabled):not(.disabled).active, .btn-outline-primary:not(:disabled):not(.disabled):active { + color: #fd7e14; + border-color: #fd7e14; +} +.btn-outline-primary:hover, .btn-outline-primary:not(:disabled):not(.disabled).active:hover, .btn-outline-primary:not(:disabled):not(.disabled):active:hover { + background-color: #fd7e14; + border-color: #fd7e14; + color: #fff; +} + +.progress-bar, +.nav-pills .nav-link.active, .nav-pills .show > .nav-link, .dropdown-item.active, .dropdown-item:active { + background-color: #fd7e14; +} + +.page-item.active .page-link, +.custom-radio .custom-control-input:checked ~ .custom-control-label:before, +.custom-control-input:checked ~ .custom-control-label::before, +.custom-checkbox .custom-control-input:checked ~ .custom-control-label:before, +.custom-control-input:checked ~ .custom-control-label:before { + background-color: #fd7e14; + border-color: #fd7e14; +} + +.list-group-item.active { + background-color: #fd7e14; + border-color: #fd7e14; +} + +.page-link { + color: #fd7e14; +} +.page-link:hover { + color: #eb6c02; +} diff --git a/docs/assets/css/color-purple.css b/docs/assets/css/color-purple.css new file mode 100644 index 0000000..f196739 --- /dev/null +++ b/docs/assets/css/color-purple.css @@ -0,0 +1,159 @@ +/*============================ + COLOR Purple +==============================*/ +::selection { + background: #6f42c1; +} + +a, a:focus { + color: #6f42c1; +} + +a:hover, a:active { + color: #5f37a8; +} + +.primary-menu ul.navbar-nav > li:hover > a:not(.btn), .primary-menu ul.navbar-nav > li > a.active:not(.btn) { + color: #6f42c1; +} +.primary-menu ul.navbar-nav > li.dropdown .dropdown-menu li:hover > a:not(.btn) { + color: #6f42c1; +} +.primary-menu.navbar-line-under-text ul.navbar-nav > li > a:not(.btn):after { + border-color: #6f42c1; +} + +/*=== Side Navigation ===*/ +.idocs-navigation .nav .nav .nav-item .nav-link.active:after, .idocs-navigation.docs-navigation-dark .nav .nav .nav-item .nav-link.active:after { + border-color: #6f42c1; +} + +/* Accordion & Toggle */ +.accordion .card-header a:hover.collapsed { + color: #6f42c1 !important; +} +.accordion:not(.accordion-alternate) .card-header a { + background-color: #6f42c1; + color: #fff; +} + +/* Nav */ +.nav:not(.nav-pills) .nav-item .nav-link.active, .nav:not(.nav-pills) .nav-item .nav-link:hover { + color: #6f42c1; +} + +.nav-tabs .nav-item .nav-link.active { + color: #0c2f55; +} +.nav-tabs .nav-item .nav-link.active:after { + background-color: #6f42c1; +} +.nav-tabs .nav-item .nav-link:not(.active):hover { + color: #6f42c1; +} +.nav-tabs.flex-column .nav-item .nav-link.active { + color: #6f42c1; +} + +.nav-pills .nav-link:not(.active):hover { + color: #6f42c1; +} + +#footer .nav .nav-item .nav-link:focus { + color: #6f42c1; +} +#footer .nav .nav-link:hover { + color: #6f42c1; +} +#footer .footer-copyright .nav .nav-link:hover { + color: #6f42c1; +} + +/* Back to Top */ +#back-to-top:hover { + background-color: #6f42c1; +} + +/* Extras */ +.bg-primary, .badge-primary { + background-color: #6f42c1 !important; +} + +.text-primary, .btn-light, .btn-outline-light:hover, .btn-link, .btn-outline-light:not(:disabled):not(.disabled).active, .btn-outline-light:not(:disabled):not(.disabled):active { + color: #6f42c1 !important; +} + +.btn-link:hover { + color: #5f37a8 !important; +} + +.text-muted { + color: #8e9a9d !important; +} + +.text-light { + color: #dee3e4 !important; +} + +a.bg-primary:focus, a.bg-primary:hover, button.bg-primary:focus, button.bg-primary:hover { + background-color: #5f37a8 !important; +} + +.border-primary { + border-color: #6f42c1 !important; +} + +.btn-primary { + background-color: #6f42c1; + border-color: #6f42c1; +} +.btn-primary:hover { + background-color: #5f37a8; + border-color: #5f37a8; +} + +.btn-primary:not(:disabled):not(.disabled).active, .btn-primary:not(:disabled):not(.disabled):active { + background-color: #5f37a8; + border-color: #5f37a8; +} + +.btn-primary.focus, .btn-primary:focus { + background-color: #5f37a8; + border-color: #5f37a8; +} + +.btn-outline-primary, .btn-outline-primary:not(:disabled):not(.disabled).active, .btn-outline-primary:not(:disabled):not(.disabled):active { + color: #6f42c1; + border-color: #6f42c1; +} +.btn-outline-primary:hover, .btn-outline-primary:not(:disabled):not(.disabled).active:hover, .btn-outline-primary:not(:disabled):not(.disabled):active:hover { + background-color: #6f42c1; + border-color: #6f42c1; + color: #fff; +} + +.progress-bar, +.nav-pills .nav-link.active, .nav-pills .show > .nav-link, .dropdown-item.active, .dropdown-item:active { + background-color: #6f42c1; +} + +.page-item.active .page-link, +.custom-radio .custom-control-input:checked ~ .custom-control-label:before, +.custom-control-input:checked ~ .custom-control-label::before, +.custom-checkbox .custom-control-input:checked ~ .custom-control-label:before, +.custom-control-input:checked ~ .custom-control-label:before { + background-color: #6f42c1; + border-color: #6f42c1; +} + +.list-group-item.active { + background-color: #6f42c1; + border-color: #6f42c1; +} + +.page-link { + color: #6f42c1; +} +.page-link:hover { + color: #5f37a8; +} diff --git a/docs/assets/css/color-red.css b/docs/assets/css/color-red.css new file mode 100644 index 0000000..e9d68d6 --- /dev/null +++ b/docs/assets/css/color-red.css @@ -0,0 +1,159 @@ +/*============================ + COLOR Red +==============================*/ +::selection { + background: #dc3545; +} + +a, a:focus { + color: #dc3545; +} + +a:hover, a:active { + color: #ca2333; +} + +.primary-menu ul.navbar-nav > li:hover > a:not(.btn), .primary-menu ul.navbar-nav > li > a.active:not(.btn) { + color: #dc3545; +} +.primary-menu ul.navbar-nav > li.dropdown .dropdown-menu li:hover > a:not(.btn) { + color: #dc3545; +} +.primary-menu.navbar-line-under-text ul.navbar-nav > li > a:not(.btn):after { + border-color: #dc3545; +} + +/*=== Side Navigation ===*/ +.idocs-navigation .nav .nav .nav-item .nav-link.active:after, .idocs-navigation.docs-navigation-dark .nav .nav .nav-item .nav-link.active:after { + border-color: #dc3545; +} + +/* Accordion & Toggle */ +.accordion .card-header a:hover.collapsed { + color: #dc3545 !important; +} +.accordion:not(.accordion-alternate) .card-header a { + background-color: #dc3545; + color: #fff; +} + +/* Nav */ +.nav:not(.nav-pills) .nav-item .nav-link.active, .nav:not(.nav-pills) .nav-item .nav-link:hover { + color: #dc3545; +} + +.nav-tabs .nav-item .nav-link.active { + color: #0c2f55; +} +.nav-tabs .nav-item .nav-link.active:after { + background-color: #dc3545; +} +.nav-tabs .nav-item .nav-link:not(.active):hover { + color: #dc3545; +} +.nav-tabs.flex-column .nav-item .nav-link.active { + color: #dc3545; +} + +.nav-pills .nav-link:not(.active):hover { + color: #dc3545; +} + +#footer .nav .nav-item .nav-link:focus { + color: #dc3545; +} +#footer .nav .nav-link:hover { + color: #dc3545; +} +#footer .footer-copyright .nav .nav-link:hover { + color: #dc3545; +} + +/* Back to Top */ +#back-to-top:hover { + background-color: #dc3545; +} + +/* Extras */ +.bg-primary, .badge-primary { + background-color: #dc3545 !important; +} + +.text-primary, .btn-light, .btn-outline-light:hover, .btn-link, .btn-outline-light:not(:disabled):not(.disabled).active, .btn-outline-light:not(:disabled):not(.disabled):active { + color: #dc3545 !important; +} + +.btn-link:hover { + color: #ca2333 !important; +} + +.text-muted { + color: #8e9a9d !important; +} + +.text-light { + color: #dee3e4 !important; +} + +a.bg-primary:focus, a.bg-primary:hover, button.bg-primary:focus, button.bg-primary:hover { + background-color: #ca2333 !important; +} + +.border-primary { + border-color: #dc3545 !important; +} + +.btn-primary { + background-color: #dc3545; + border-color: #dc3545; +} +.btn-primary:hover { + background-color: #ca2333; + border-color: #ca2333; +} + +.btn-primary:not(:disabled):not(.disabled).active, .btn-primary:not(:disabled):not(.disabled):active { + background-color: #ca2333; + border-color: #ca2333; +} + +.btn-primary.focus, .btn-primary:focus { + background-color: #ca2333; + border-color: #ca2333; +} + +.btn-outline-primary, .btn-outline-primary:not(:disabled):not(.disabled).active, .btn-outline-primary:not(:disabled):not(.disabled):active { + color: #dc3545; + border-color: #dc3545; +} +.btn-outline-primary:hover, .btn-outline-primary:not(:disabled):not(.disabled).active:hover, .btn-outline-primary:not(:disabled):not(.disabled):active:hover { + background-color: #dc3545; + border-color: #dc3545; + color: #fff; +} + +.progress-bar, +.nav-pills .nav-link.active, .nav-pills .show > .nav-link, .dropdown-item.active, .dropdown-item:active { + background-color: #dc3545; +} + +.page-item.active .page-link, +.custom-radio .custom-control-input:checked ~ .custom-control-label:before, +.custom-control-input:checked ~ .custom-control-label::before, +.custom-checkbox .custom-control-input:checked ~ .custom-control-label:before, +.custom-control-input:checked ~ .custom-control-label:before { + background-color: #dc3545; + border-color: #dc3545; +} + +.list-group-item.active { + background-color: #dc3545; + border-color: #dc3545; +} + +.page-link { + color: #dc3545; +} +.page-link:hover { + color: #ca2333; +} diff --git a/docs/assets/css/color-teal.css b/docs/assets/css/color-teal.css new file mode 100644 index 0000000..8b8116a --- /dev/null +++ b/docs/assets/css/color-teal.css @@ -0,0 +1,159 @@ +/*============================ + COLOR Teal +==============================*/ +::selection { + background: #20c997; +} + +a, a:focus { + color: #20c997; +} + +a:hover, a:active { + color: #1baa80; +} + +.primary-menu ul.navbar-nav > li:hover > a:not(.btn), .primary-menu ul.navbar-nav > li > a.active:not(.btn) { + color: #20c997; +} +.primary-menu ul.navbar-nav > li.dropdown .dropdown-menu li:hover > a:not(.btn) { + color: #20c997; +} +.primary-menu.navbar-line-under-text ul.navbar-nav > li > a:not(.btn):after { + border-color: #20c997; +} + +/*=== Side Navigation ===*/ +.idocs-navigation .nav .nav .nav-item .nav-link.active:after, .idocs-navigation.docs-navigation-dark .nav .nav .nav-item .nav-link.active:after { + border-color: #20c997; +} + +/* Accordion & Toggle */ +.accordion .card-header a:hover.collapsed { + color: #20c997 !important; +} +.accordion:not(.accordion-alternate) .card-header a { + background-color: #20c997; + color: #fff; +} + +/* Nav */ +.nav:not(.nav-pills) .nav-item .nav-link.active, .nav:not(.nav-pills) .nav-item .nav-link:hover { + color: #20c997; +} + +.nav-tabs .nav-item .nav-link.active { + color: #0c2f55; +} +.nav-tabs .nav-item .nav-link.active:after { + background-color: #20c997; +} +.nav-tabs .nav-item .nav-link:not(.active):hover { + color: #20c997; +} +.nav-tabs.flex-column .nav-item .nav-link.active { + color: #20c997; +} + +.nav-pills .nav-link:not(.active):hover { + color: #20c997; +} + +#footer .nav .nav-item .nav-link:focus { + color: #20c997; +} +#footer .nav .nav-link:hover { + color: #20c997; +} +#footer .footer-copyright .nav .nav-link:hover { + color: #20c997; +} + +/* Back to Top */ +#back-to-top:hover { + background-color: #20c997; +} + +/* Extras */ +.bg-primary, .badge-primary { + background-color: #20c997 !important; +} + +.text-primary, .btn-light, .btn-outline-light:hover, .btn-link, .btn-outline-light:not(:disabled):not(.disabled).active, .btn-outline-light:not(:disabled):not(.disabled):active { + color: #20c997 !important; +} + +.btn-link:hover { + color: #1baa80 !important; +} + +.text-muted { + color: #8e9a9d !important; +} + +.text-light { + color: #dee3e4 !important; +} + +a.bg-primary:focus, a.bg-primary:hover, button.bg-primary:focus, button.bg-primary:hover { + background-color: #1baa80 !important; +} + +.border-primary { + border-color: #20c997 !important; +} + +.btn-primary { + background-color: #20c997; + border-color: #20c997; +} +.btn-primary:hover { + background-color: #1baa80; + border-color: #1baa80; +} + +.btn-primary:not(:disabled):not(.disabled).active, .btn-primary:not(:disabled):not(.disabled):active { + background-color: #1baa80; + border-color: #1baa80; +} + +.btn-primary.focus, .btn-primary:focus { + background-color: #1baa80; + border-color: #1baa80; +} + +.btn-outline-primary, .btn-outline-primary:not(:disabled):not(.disabled).active, .btn-outline-primary:not(:disabled):not(.disabled):active { + color: #20c997; + border-color: #20c997; +} +.btn-outline-primary:hover, .btn-outline-primary:not(:disabled):not(.disabled).active:hover, .btn-outline-primary:not(:disabled):not(.disabled):active:hover { + background-color: #20c997; + border-color: #20c997; + color: #fff; +} + +.progress-bar, +.nav-pills .nav-link.active, .nav-pills .show > .nav-link, .dropdown-item.active, .dropdown-item:active { + background-color: #20c997; +} + +.page-item.active .page-link, +.custom-radio .custom-control-input:checked ~ .custom-control-label:before, +.custom-control-input:checked ~ .custom-control-label::before, +.custom-checkbox .custom-control-input:checked ~ .custom-control-label:before, +.custom-control-input:checked ~ .custom-control-label:before { + background-color: #20c997; + border-color: #20c997; +} + +.list-group-item.active { + background-color: #20c997; + border-color: #20c997; +} + +.page-link { + color: #20c997; +} +.page-link:hover { + color: #1baa80; +} diff --git a/docs/assets/css/color-yellow.css b/docs/assets/css/color-yellow.css new file mode 100644 index 0000000..6c59cad --- /dev/null +++ b/docs/assets/css/color-yellow.css @@ -0,0 +1,159 @@ +/*============================ + COLOR Yellow +==============================*/ +::selection { + background: #ffc107; +} + +a, a:focus { + color: #ffc107; +} + +a:hover, a:active { + color: #f7b900; +} + +.primary-menu ul.navbar-nav > li:hover > a:not(.btn), .primary-menu ul.navbar-nav > li > a.active:not(.btn) { + color: #ffc107; +} +.primary-menu ul.navbar-nav > li.dropdown .dropdown-menu li:hover > a:not(.btn) { + color: #ffc107; +} +.primary-menu.navbar-line-under-text ul.navbar-nav > li > a:not(.btn):after { + border-color: #ffc107; +} + +/*=== Side Navigation ===*/ +.idocs-navigation .nav .nav .nav-item .nav-link.active:after, .idocs-navigation.docs-navigation-dark .nav .nav .nav-item .nav-link.active:after { + border-color: #ffc107; +} + +/* Accordion & Toggle */ +.accordion .card-header a:hover.collapsed { + color: #ffc107 !important; +} +.accordion:not(.accordion-alternate) .card-header a { + background-color: #ffc107; + color: #fff; +} + +/* Nav */ +.nav:not(.nav-pills) .nav-item .nav-link.active, .nav:not(.nav-pills) .nav-item .nav-link:hover { + color: #ffc107; +} + +.nav-tabs .nav-item .nav-link.active { + color: #0c2f55; +} +.nav-tabs .nav-item .nav-link.active:after { + background-color: #ffc107; +} +.nav-tabs .nav-item .nav-link:not(.active):hover { + color: #ffc107; +} +.nav-tabs.flex-column .nav-item .nav-link.active { + color: #ffc107; +} + +.nav-pills .nav-link:not(.active):hover { + color: #ffc107; +} + +#footer .nav .nav-item .nav-link:focus { + color: #ffc107; +} +#footer .nav .nav-link:hover { + color: #ffc107; +} +#footer .footer-copyright .nav .nav-link:hover { + color: #ffc107; +} + +/* Back to Top */ +#back-to-top:hover { + background-color: #ffc107; +} + +/* Extras */ +.bg-primary, .badge-primary { + background-color: #ffc107 !important; +} + +.text-primary, .btn-light, .btn-outline-light:hover, .btn-link, .btn-outline-light:not(:disabled):not(.disabled).active, .btn-outline-light:not(:disabled):not(.disabled):active { + color: #ffc107 !important; +} + +.btn-link:hover { + color: #f7b900 !important; +} + +.text-muted { + color: #8e9a9d !important; +} + +.text-light { + color: #dee3e4 !important; +} + +a.bg-primary:focus, a.bg-primary:hover, button.bg-primary:focus, button.bg-primary:hover { + background-color: #f7b900 !important; +} + +.border-primary { + border-color: #ffc107 !important; +} + +.btn-primary { + background-color: #ffc107; + border-color: #ffc107; +} +.btn-primary:hover { + background-color: #f7b900; + border-color: #f7b900; +} + +.btn-primary:not(:disabled):not(.disabled).active, .btn-primary:not(:disabled):not(.disabled):active { + background-color: #f7b900; + border-color: #f7b900; +} + +.btn-primary.focus, .btn-primary:focus { + background-color: #f7b900; + border-color: #f7b900; +} + +.btn-outline-primary, .btn-outline-primary:not(:disabled):not(.disabled).active, .btn-outline-primary:not(:disabled):not(.disabled):active { + color: #ffc107; + border-color: #ffc107; +} +.btn-outline-primary:hover, .btn-outline-primary:not(:disabled):not(.disabled).active:hover, .btn-outline-primary:not(:disabled):not(.disabled):active:hover { + background-color: #ffc107; + border-color: #ffc107; + color: #fff; +} + +.progress-bar, +.nav-pills .nav-link.active, .nav-pills .show > .nav-link, .dropdown-item.active, .dropdown-item:active { + background-color: #ffc107; +} + +.page-item.active .page-link, +.custom-radio .custom-control-input:checked ~ .custom-control-label:before, +.custom-control-input:checked ~ .custom-control-label::before, +.custom-checkbox .custom-control-input:checked ~ .custom-control-label:before, +.custom-control-input:checked ~ .custom-control-label:before { + background-color: #ffc107; + border-color: #ffc107; +} + +.list-group-item.active { + background-color: #ffc107; + border-color: #ffc107; +} + +.page-link { + color: #ffc107; +} +.page-link:hover { + color: #f7b900; +} diff --git a/docs/assets/css/stylesheet.css b/docs/assets/css/stylesheet.css new file mode 100644 index 0000000..e94a0e1 --- /dev/null +++ b/docs/assets/css/stylesheet.css @@ -0,0 +1,2983 @@ +/*=========================================================== + + Template Name: iDocs - One Page Documentation HTML Template + Author: Harnish Design + Template URL: http://demo.harnishdesign.net/html/idocs + Author URL: https://themeforest.net/user/harnishdesign + File Description : Main css file of the template + +================================================= + Table of Contents +================================================= + + 1. Basic + 2. Helpers Classes + 3. Layouts + 3.1 Side Navigation + 3.2 Docs Content + 3.3 Section Divider + 4. Header + 4.1 Main Navigation + 5 Elements + 5.1 List Style + 5.2 Changelog + 5.3 Accordion & Toggle + 5.4 Nav + 5.5 Tabs + 5.6 Popup Img + 5.7 Featured Box + 6 Footer + 6.1 Social Icons + 6.2 Back to Top + 7 Extra + +=======================================================*/ +/* =================================== */ +/* 1. Basic Style +/* =================================== */ +body, html { + height: 100%; +} + +body { + background: #dddddd; + color: #4c4d4d; +} + +/*-------- Preloader --------*/ +.preloader { + position: fixed; + width: 100%; + height: 100%; + z-index: 999999999 !important; + background-color: #fff; + top: 0; + left: 0; + right: 0; + bottom: 0; +} +.preloader .lds-ellipsis { + display: inline-block; + position: absolute; + width: 80px; + height: 80px; + margin-top: -40px; + margin-left: -40px; + top: 50%; + left: 50%; +} +.preloader .lds-ellipsis div { + position: absolute; + top: 33px; + width: 13px; + height: 13px; + border-radius: 50%; + background: #000; + animation-timing-function: cubic-bezier(0, 1, 1, 0); +} +.preloader .lds-ellipsis div:nth-child(1) { + left: 8px; + animation: lds-ellipsis1 0.6s infinite; +} +.preloader .lds-ellipsis div:nth-child(2) { + left: 8px; + animation: lds-ellipsis2 0.6s infinite; +} +.preloader .lds-ellipsis div:nth-child(3) { + left: 32px; + animation: lds-ellipsis2 0.6s infinite; +} +.preloader .lds-ellipsis div:nth-child(4) { + left: 56px; + animation: lds-ellipsis3 0.6s infinite; +} + +@keyframes lds-ellipsis1 { + 0% { + transform: scale(0); + } + 100% { + transform: scale(1); + } +} +@keyframes lds-ellipsis3 { + 0% { + transform: scale(1); + } + 100% { + transform: scale(0); + } +} +@keyframes lds-ellipsis2 { + 0% { + transform: translate(0, 0); + } + 100% { + transform: translate(24px, 0); + } +} +/*--- Preloader Magnific Popup ----*/ +.mfp-container .preloader { + background: transparent; +} +.mfp-container .preloader .lds-ellipsis div { + background: #fff; +} + +::selection { + background: #0366d6; + color: #fff; + text-shadow: none; +} + +code { + padding: 2px 5px; + background-color: #f9f2f4; + border-radius: 4px; +} + +form { + padding: 0; + margin: 0; + display: inline; +} + +img { + vertical-align: inherit; +} + +a, a:focus { + color: #0366d6; + -webkit-transition: all 0.2s ease; + transition: all 0.2s ease; +} + +a:hover, a:active { + color: #0355b3; + -webkit-transition: all 0.2s ease; + transition: all 0.2s ease; +} + +a:focus, a:active, +.btn.active.focus, +.btn.active:focus, +.btn.focus, +.btn:active.focus, +.btn:active:focus, +.btn:focus, +button:focus, +button:active { + outline: none; +} + +p { + line-height: 1.8; +} + +blockquote { + border-left: 5px solid #eee; + padding: 10px 20px; +} + +iframe { + border: 0 !important; +} + +h1, h2, h3, h4, h5, h6 { + color: #252b33; + line-height: 1.5; + margin: 0 0 1.5rem 0; + font-family: Roboto, sans-serif; +} + +h1 { + font-size: 3rem; +} + +h2 { + font-size: 2.2rem; +} + +dl, ol, ul, pre, blockquote, .table { + margin-bottom: 1.8rem; +} + +/*=== Highlight Js ===*/ +.hljs { + padding: 1.5rem; +} + +/* =================================== */ +/* 2. Helpers Classes +/* =================================== */ +/* Box Shadow */ +.shadow-md { + -webkit-box-shadow: 0px 0px 50px -35px rgba(0, 0, 0, 0.4) !important; + box-shadow: 0px 0px 50px -35px rgba(0, 0, 0, 0.4) !important; +} + +/* Border Radius */ +.rounded-lg { + border-radius: 0.6rem !important; +} + +.rounded-top-0 { + border-top-left-radius: 0px !important; + border-top-right-radius: 0px !important; +} + +.rounded-bottom-0 { + border-bottom-left-radius: 0px !important; + border-bottom-right-radius: 0px !important; +} + +.rounded-left-0 { + border-top-left-radius: 0px !important; + border-bottom-left-radius: 0px !important; +} + +.rounded-right-0 { + border-top-right-radius: 0px !important; + border-bottom-right-radius: 0px !important; +} + +/* Border Size */ +.border-1 { + border-width: 1px !important; +} + +.border-2 { + border-width: 2px !important; +} + +.border-3 { + border-width: 3px !important; +} + +.border-4 { + border-width: 4px !important; +} + +.border-5 { + border-width: 5px !important; +} + +/* Text Size */ +.text-0 { + font-size: 11px !important; + font-size: 0.6875rem !important; +} + +.text-1 { + font-size: 12px !important; + font-size: 0.75rem !important; +} + +.text-2 { + font-size: 14px !important; + font-size: 0.875rem !important; +} + +.text-3 { + font-size: 16px !important; + font-size: 1rem !important; +} + +.text-4 { + font-size: 18px !important; + font-size: 1.125rem !important; +} + +.text-5 { + font-size: 21px !important; + font-size: 1.3125rem !important; +} + +.text-6 { + font-size: 24px !important; + font-size: 1.50rem !important; +} + +.text-7 { + font-size: 28px !important; + font-size: 1.75rem !important; +} + +.text-8 { + font-size: 32px !important; + font-size: 2rem !important; +} + +.text-9 { + font-size: 36px !important; + font-size: 2.25rem !important; +} + +.text-10 { + font-size: 40px !important; + font-size: 2.50rem !important; +} + +.text-11 { + font-size: 2.75rem !important; +} +@media (max-width: 992px) { + .text-11 { + font-size: calc(1.4rem + 2.1774193548vw) !important; + } +} + +.text-12 { + font-size: 3rem !important; +} +@media (max-width: 992px) { + .text-12 { + font-size: calc(1.425rem + 2.5403225806vw) !important; + } +} + +.text-13 { + font-size: 3.25rem !important; +} +@media (max-width: 992px) { + .text-13 { + font-size: calc(1.45rem + 2.9032258065vw) !important; + } +} + +.text-14 { + font-size: 3.5rem !important; +} +@media (max-width: 992px) { + .text-14 { + font-size: calc(1.475rem + 3.2661290323vw) !important; + } +} + +.text-15 { + font-size: 3.75rem !important; +} +@media (max-width: 992px) { + .text-15 { + font-size: calc(1.5rem + 3.6290322581vw) !important; + } +} + +.text-16 { + font-size: 4rem !important; +} +@media (max-width: 992px) { + .text-16 { + font-size: calc(1.525rem + 3.9919354839vw) !important; + } +} + +.text-17 { + font-size: 4.5rem !important; +} +@media (max-width: 992px) { + .text-17 { + font-size: calc(1.575rem + 4.7177419355vw) !important; + } +} + +.text-18 { + font-size: 5rem !important; +} +@media (max-width: 992px) { + .text-18 { + font-size: calc(1.625rem + 5.4435483871vw) !important; + } +} + +.text-19 { + font-size: 5.25rem !important; +} +@media (max-width: 992px) { + .text-19 { + font-size: calc(1.65rem + 5.8064516129vw) !important; + } +} + +.text-20 { + font-size: 5.75rem !important; +} +@media (max-width: 992px) { + .text-20 { + font-size: calc(1.7rem + 6.5322580645vw) !important; + } +} + +.text-21 { + font-size: 6.5rem !important; +} +@media (max-width: 992px) { + .text-21 { + font-size: calc(1.775rem + 7.6209677419vw) !important; + } +} + +.text-22 { + font-size: 7rem !important; +} +@media (max-width: 992px) { + .text-22 { + font-size: calc(1.825rem + 8.3467741935vw) !important; + } +} + +.text-23 { + font-size: 7.75rem !important; +} +@media (max-width: 992px) { + .text-23 { + font-size: calc(1.9rem + 9.435483871vw) !important; + } +} + +.text-24 { + font-size: 8.25rem !important; +} +@media (max-width: 992px) { + .text-24 { + font-size: calc(1.95rem + 10.1612903226vw) !important; + } +} + +.text-25 { + font-size: 9rem !important; +} +@media (max-width: 992px) { + .text-25 { + font-size: calc(2.025rem + 11.25vw) !important; + } +} + +.text-11, .text-12, .text-13, .text-14, .text-15, .text-16, .text-17, .text-18, .text-19, .text-20, .text-21, .text-22, .text-23, .text-24, .text-25 { + line-height: 1.3; +} + +/* Line height */ +.line-height-07 { + line-height: 0.7 !important; +} + +.line-height-1 { + line-height: 1 !important; +} + +.line-height-2 { + line-height: 1.2 !important; +} + +.line-height-3 { + line-height: 1.4 !important; +} + +.line-height-4 { + line-height: 1.6 !important; +} + +.line-height-5 { + line-height: 1.8 !important; +} + +/* Font Weight */ +.font-weight-100 { + font-weight: 100 !important; +} + +.font-weight-200 { + font-weight: 200 !important; +} + +.font-weight-300 { + font-weight: 300 !important; +} + +.font-weight-400 { + font-weight: 400 !important; +} + +.font-weight-500 { + font-weight: 500 !important; +} + +.font-weight-600 { + font-weight: 600 !important; +} + +.font-weight-700 { + font-weight: 700 !important; +} + +.font-weight-800 { + font-weight: 800 !important; +} + +.font-weight-900 { + font-weight: 900 !important; +} + +/* Opacity */ +.opacity-0 { + opacity: 0; +} + +.opacity-1 { + opacity: 0.1; +} + +.opacity-2 { + opacity: 0.2; +} + +.opacity-3 { + opacity: 0.3; +} + +.opacity-4 { + opacity: 0.4; +} + +.opacity-5 { + opacity: 0.5; +} + +.opacity-6 { + opacity: 0.6; +} + +.opacity-7 { + opacity: 0.7; +} + +.opacity-8 { + opacity: 0.8; +} + +.opacity-9 { + opacity: 0.9; +} + +.opacity-10 { + opacity: 1; +} + +/* Background light */ +.bg-light-1 { + background-color: #e9ecef !important; +} + +.bg-light-2 { + background-color: #dee2e6 !important; +} + +.bg-light-3 { + background-color: #ced4da !important; +} + +.bg-light-4 { + background-color: #adb5bd !important; +} + +/* Background Dark */ +.bg-dark { + background-color: #111418 !important; +} + +.bg-dark-1 { + background-color: #212529 !important; +} + +.bg-dark-2 { + background-color: #343a40 !important; +} + +.bg-dark-3 { + background-color: #495057 !important; +} + +.bg-dark-4 { + background-color: #6c757d !important; +} + +/* Progress Bar */ +.progress-sm { + height: 0.5rem !important; +} + +.progress-lg { + height: 1.5rem !important; +} + +hr { + border-top: 1px solid rgba(16, 85, 96, 0.1); +} + +/* =================================== */ +/* 3. Layouts +/* =================================== */ +#main-wrapper { + background: #fff; +} + +.box #main-wrapper { + max-width: 1200px; + margin: 0 auto; + -webkit-box-shadow: 0px 0px 10px rgba(0, 0, 0, 0.1); + box-shadow: 0px 0px 10px rgba(0, 0, 0, 0.1); +} +.box .idocs-navigation { + left: auto; +} + +@media (min-width: 1200px) { + .container { + max-width: 1170px !important; + } +} +/*=== 3.1 Side Navigation ===*/ +.idocs-navigation { + position: fixed; + top: 70px; + left: 0; + overflow: hidden; + overflow-y: auto; + width: 260px; + height: calc(100% - 70px); + z-index: 1; + border-right: 1px solid rgba(0, 0, 0, 0.05); + transition: all 0.3s; +} +.idocs-navigation > .nav { + padding: 30px 0; +} +.idocs-navigation .nav .nav-item { + position: relative; +} +.idocs-navigation .nav .nav { + margin: 0 0 5px; +} +.idocs-navigation .nav .nav-link { + position: relative; + padding: 6px 30px; + line-height: 25px; + font-weight: 600; +} +.idocs-navigation .nav .nav-item:hover > .nav-link, .idocs-navigation .nav .nav-item .nav-link.active { + font-weight: 700; +} +.idocs-navigation .nav .nav { + display: none; + border-left: 1px solid regba(0, 0, 0, 0.3); +} +.idocs-navigation .nav .nav .nav-item .nav-link:after { + content: ""; + position: absolute; + left: 30px; + height: 100%; + border-left: 1px solid rgba(0, 0, 0, 0.12); + width: 1px; + top: 0; +} +.idocs-navigation .nav .nav .nav-item .nav-link.active:after { + border-color: #0366d6; + border-width: 2px; +} +.idocs-navigation .nav .nav-item .nav-link.active + .nav { + display: block; +} +.idocs-navigation .nav .nav .nav-link { + color: #6a6a6a; + padding: 4px 30px 4px 45px; + font-size: 15px; + text-transform: none; +} +.idocs-navigation .nav .nav .nav .nav-link { + padding: 4px 30px 4px 60px; + font-size: 15px; +} +.idocs-navigation .nav .nav .nav .nav-item .nav-link:after { + left: 45px; +} +.idocs-navigation > .nav > .nav-item > .nav-link.active:after { + position: absolute; + content: " "; + top: 50%; + right: 18px; + border-color: #000; + border-top: 2px solid; + border-right: 2px solid; + width: 7px; + height: 7px; + -webkit-transform: translate(-50%, -50%) rotate(45deg); + transform: translate(-50%, -50%) rotate(45deg); + -webkit-transition: all 0.2s ease; + transition: all 0.2s ease; +} +.idocs-navigation.docs-navigation-dark .nav .nav-link { + color: rgba(250, 250, 250, 0.85); +} +.idocs-navigation.docs-navigation-dark .nav .nav .nav-link { + color: rgba(250, 250, 250, 0.7); +} +.idocs-navigation.docs-navigation-dark .nav .nav .nav-item .nav-link:after { + border-color: rgba(250, 250, 250, 0.2); +} +.idocs-navigation.docs-navigation-dark .nav .nav .nav-item .nav-link.active:after { + border-color: #0366d6; +} + +/*=== 3.2 Docs Content ===*/ +.idocs-content { + position: relative; + margin-left: 260px; + padding: 0px 50px 50px; + min-height: 750px; + transition: all 0.3s; +} +.idocs-content section:first-child { + padding-top: 3rem; +} +.idocs-content ol li, .idocs-content ul li { + margin-top: 10px; +} + +@media (max-width: 767.98px) { + .idocs-navigation { + margin-left: -260px; + } + .idocs-navigation.active { + margin-left: 0; + } + + .idocs-content { + margin-left: 0px; + padding: 0px; + } +} +/*=== 3.3 Section Divider ===*/ +.divider { + margin: 4rem 0; +} + +/* =================================== */ +/* 4. Header +/* =================================== */ +#header { + -webkit-transition: all 0.5s ease; + transition: all 0.5s ease; +} +#header .navbar { + padding: 0px; + min-height: 70px; +} +#header .logo { + -webkit-box-align: center; + -ms-flex-align: center; + align-items: center; + display: -webkit-box; + display: -ms-flexbox; + display: flex; + -ms-flex-item-align: stretch; + align-self: stretch; +} + +/*=== 4.1 Main Navigation ===*/ +.navbar-light .navbar-nav .active > .nav-link { + color: #0c2f55; +} +.navbar-light .navbar-nav .nav-link.active, .navbar-light .navbar-nav .nav-link.show { + color: #0c2f55; +} +.navbar-light .navbar-nav .show > .nav-link { + color: #0c2f55; +} + +.primary-menu { + display: -webkit-box !important; + display: -ms-flexbox !important; + display: flex !important; + height: auto !important; + -webkit-box-ordinal-group: 0; + -ms-flex-item-align: stretch; + align-self: stretch; + background: #fff; + border-bottom: 1px solid #efefef; +} +.primary-menu.bg-transparent { + position: absolute; + z-index: 999; + top: 0; + left: 0; + width: 100%; + box-shadow: none; + border-bottom: 1px solid rgba(250, 250, 250, 0.3); +} +.primary-menu.sticky-on { + position: fixed; + top: 0; + width: 100%; + z-index: 1020; + left: 0; + -webkit-box-shadow: 0px 0px 10px rgba(0, 0, 0, 0.05); + box-shadow: 0px 0px 10px rgba(0, 0, 0, 0.05); + -webkit-animation: slide-down 0.7s; + -moz-animation: slide-down 0.7s; + animation: slide-down 0.7s; +} +@-webkit-keyframes slide-down { + 0% { + opacity: 0; + transform: translateY(-100%); + } + 100% { + opacity: 1; + transform: translateY(0); + } +} +@-moz-keyframes slide-down { + 0% { + opacity: 0; + transform: translateY(-100%); + } + 100% { + opacity: 1; + transform: translateY(0); + } +} +@keyframes slide-down { + 0% { + opacity: 0; + transform: translateY(-100%); + } + 100% { + opacity: 1; + transform: translateY(0); + } +} +.primary-menu.sticky-on .none-on-sticky { + display: none !important; +} +.primary-menu ul.navbar-nav > li { + display: -webkit-box; + display: -ms-flexbox; + display: flex; + height: 100%; +} +.primary-menu ul.navbar-nav > li + li { + margin-left: 2px; +} +.primary-menu ul.navbar-nav > li a { + display: -webkit-box; + display: -ms-flexbox; + display: flex; + -webkit-box-align: center; + -ms-flex-align: center; + align-items: center; +} +.primary-menu ul.navbar-nav > li > a:not(.btn) { + height: 70px; + padding: 0px 0.85em; + color: #252b33; + -webkit-transition: all 0.2s ease; + transition: all 0.2s ease; + position: relative; + position: relative; +} +.primary-menu ul.navbar-nav > li:hover > a:not(.btn), .primary-menu ul.navbar-nav > li > a.active:not(.btn) { + color: #0366d6; + text-decoration: none; + -webkit-transition: all 0.2s ease; + transition: all 0.2s ease; +} +.primary-menu ul.navbar-nav > li a.btn { + padding: 0.4rem 1.4rem; +} +.primary-menu ul.navbar-nav > li.dropdown .dropdown-menu li > a:not(.btn) { + padding: 8px 0px; + background-color: transparent; + text-transform: none; + color: #777; + -webkit-transition: all 0.2s ease; + transition: all 0.2s ease; +} +.primary-menu ul.navbar-nav > li.dropdown .dropdown-menu li:hover > a:not(.btn) { + color: #0366d6; + -webkit-transition: all 0.2s ease; + transition: all 0.2s ease; +} +.primary-menu ul.navbar-nav > li.dropdown:hover > a:after { + clear: both; + content: ' '; + display: block; + width: 0; + height: 0; + border-style: solid; + border-color: transparent transparent #fff transparent; + position: absolute; + border-width: 0px 7px 6px 7px; + bottom: 0px; + left: 50%; + margin: 0 0 0 -5px; + z-index: 1022; +} +.primary-menu ul.navbar-nav > li.dropdown .dropdown-menu { + -webkit-box-shadow: 0px 0px 12px rgba(0, 0, 0, 0.176); + box-shadow: 0px 0px 12px rgba(0, 0, 0, 0.176); + border: 0px none; + padding: 10px 15px; + min-width: 220px; + margin: 0; + font-size: 14px; + font-size: 0.875rem; + z-index: 1021; +} +.primary-menu ul.navbar-nav > li.dropdown > .dropdown-toggle .arrow { + display: none; +} +.primary-menu .dropdown-menu-right { + left: auto !important; + right: 100% !important; +} +.primary-menu ul.navbar-nav > li.dropdown-mega { + position: static; +} +.primary-menu ul.navbar-nav > li.dropdown-mega > .dropdown-menu { + width: 100%; + padding: 20px 20px; + margin-left: 0px !important; +} +.primary-menu ul.navbar-nav > li.dropdown-mega .dropdown-mega-content > .row > div { + padding: 5px 5px 5px 20px; + border-right: 1px solid #eee; +} +.primary-menu ul.navbar-nav > li.dropdown-mega .dropdown-mega-content > .row > div:last-child { + border-right: 0; +} +.primary-menu ul.navbar-nav > li.dropdown-mega .sub-title { + display: block; + font-size: 16px; + margin-top: 1rem; + padding-bottom: 5px; +} +.primary-menu ul.navbar-nav > li.dropdown-mega .dropdown-mega-submenu { + list-style-type: none; + padding-left: 0px; +} +.primary-menu ul.navbar-nav > li a.btn { + font-size: 14px; + padding: 0.65rem 2rem; + text-transform: uppercase; +} +.primary-menu ul.navbar-nav > li.dropdown .dropdown-menu .dropdown-menu { + left: 100%; + margin-top: -40px; +} +.primary-menu ul.navbar-nav > li.dropdown .dropdown-menu .dropdown-toggle:after { + border-top: .4em solid transparent; + border-right: 0; + border-bottom: 0.4em solid transparent; + border-left: 0.4em solid; +} +.primary-menu ul.navbar-nav > li.dropdown .dropdown-toggle .arrow { + position: absolute; + min-width: 30px; + height: 100%; + right: 0px; + top: 0; + -webkit-transition: all 0.2s ease; + transition: all 0.2s ease; +} +.primary-menu ul.navbar-nav > li.dropdown .dropdown-toggle .arrow:after { + content: " "; + position: absolute; + top: 50%; + left: 50%; + border-color: #000; + border-top: 1px solid; + border-right: 1px solid; + width: 6px; + height: 6px; + -webkit-transform: translate(-50%, -50%) rotate(45deg); + transform: translate(-50%, -50%) rotate(45deg); +} +.primary-menu .dropdown-toggle:after { + content: none; +} +.primary-menu.navbar-line-under-text ul.navbar-nav > li > a:not(.btn):after { + position: absolute; + content: ""; + height: 2px; + width: 0; + left: 50%; + right: 0; + bottom: 14px; + background-color: transparent; + color: #fff; + border-bottom: 2px solid #0366d6; + -webkit-transition: all 0.3s ease-in-out; + transition: all 0.3s ease-in-out; + transform: translate(-50%, 0) translateZ(0); + -webkit-transform: translate(-50%, 0) translateZ(0); +} +.primary-menu.navbar-line-under-text ul.navbar-nav > li > a:hover:not(.logo):after, .primary-menu.navbar-line-under-text ul.navbar-nav > li > a.active:after { + width: calc(100% - 0.99em); +} + +/*== Color Options ==*/ +.primary-menu.navbar-text-light .navbar-toggler span { + background: #fff; +} + +.primary-menu.navbar-text-light .navbar-nav > li > a:not(.btn) { + color: #fff; +} +.primary-menu.navbar-text-light .navbar-nav > li:hover > a:not(.btn), .primary-menu.navbar-text-light .navbar-nav > li > a.active:not(.btn) { + color: rgba(250, 250, 250, 0.75); +} + +.primary-menu.navbar-text-light.navbar-line-under-text .navbar-nav > li > a:not(.logo):after, .primary-menu.navbar-text-light.navbar-line-under-text .navbar-nav > li > a.active:after { + border-color: rgba(250, 250, 250, 0.6); +} + +.primary-menu.navbar-dropdown-dark ul.navbar-nav > li.dropdown .dropdown-menu { + background-color: #252A2C; + color: #fff; +} +.primary-menu.navbar-dropdown-dark ul.navbar-nav > li.dropdown .dropdown-menu .dropdown-menu { + background-color: #272c2e; +} +.primary-menu.navbar-dropdown-dark ul.navbar-nav > li.dropdown:hover > a:after { + border-color: transparent transparent #252A2C transparent; +} +.primary-menu.navbar-dropdown-dark ul.navbar-nav > li.dropdown .dropdown-menu li > a:not(.btn) { + color: rgba(250, 250, 250, 0.8); +} +.primary-menu.navbar-dropdown-dark ul.navbar-nav > li.dropdown .dropdown-menu li:hover > a:not(.btn) { + color: #fafafa; + font-weight: 600; +} +.primary-menu.navbar-dropdown-dark ul.navbar-nav > li.dropdown-mega .dropdown-mega-content > .row > div { + border-color: #3a3a3a; +} +.primary-menu.navbar-dropdown-primary ul.navbar-nav > li.dropdown .dropdown-menu { + background-color: #0366d6; + color: #fff; +} +.primary-menu.navbar-dropdown-primary ul.navbar-nav > li.dropdown .dropdown-menu .dropdown-menu { + background-color: #0366d6; +} +.primary-menu.navbar-dropdown-primary ul.navbar-nav > li.dropdown:hover > a:after { + border-color: transparent transparent #0366d6 transparent; +} +.primary-menu.navbar-dropdown-primary ul.navbar-nav > li.dropdown .dropdown-menu li > a:not(.btn) { + color: rgba(250, 250, 250, 0.95); +} +.primary-menu.navbar-dropdown-primary ul.navbar-nav > li.dropdown .dropdown-menu li:hover > a:not(.btn) { + color: #fafafa; + font-weight: 600; +} +.primary-menu.navbar-dropdown-primary ul.navbar-nav > li.dropdown-mega .dropdown-mega-content > .row > div { + border-color: rgba(250, 250, 250, 0.2); +} + +/* Hamburger Menu Button */ +.navbar-toggler { + width: 25px; + height: 30px; + padding: 10px; + margin: 18px 15px; + position: relative; + border: none; + -webkit-transform: rotate(0deg); + transform: rotate(0deg); + -webkit-transition: 0.5s ease-in-out; + transition: 0.5s ease-in-out; + cursor: pointer; + display: block; +} +.navbar-toggler span { + display: block; + position: absolute; + height: 2px; + width: 100%; + background: #3c3636; + border-radius: 2px; + opacity: 1; + left: 0; + -webkit-transform: rotate(0deg); + transform: rotate(0deg); + -webkit-transition: 0.25s ease-in-out; + transition: 0.25s ease-in-out; +} +.navbar-toggler span:nth-child(1) { + top: 7px; + -webkit-transform-origin: left center; + -moz-transform-origin: left center; + -o-transform-origin: left center; + transform-origin: left center; +} +.navbar-toggler span:nth-child(2) { + top: 14px; + -webkit-transform-origin: left center; + -moz-transform-origin: left center; + -o-transform-origin: left center; + transform-origin: left center; +} +.navbar-toggler span:nth-child(3) { + top: 21px; + -webkit-transform-origin: left center; + -moz-transform-origin: left center; + -o-transform-origin: left center; + transform-origin: left center; +} +.navbar-toggler.show span:nth-child(1) { + top: 4px; + left: 3px; + -webkit-transform: rotate(45deg); + transform: rotate(45deg); +} +.navbar-toggler.show span:nth-child(2) { + width: 0%; + opacity: 0; +} +.navbar-toggler.show span:nth-child(3) { + top: 22px; + left: 3px; + -webkit-transform: rotate(-45deg); + transform: rotate(-45deg); +} + +.navbar-accordion { + position: initial; +} + +.navbar-expand-none .navbar-collapse { + position: absolute; + top: 99%; + right: 0; + left: 0; + background: #fff; + margin-top: 0px; + z-index: 1000; + -webkit-box-shadow: 0px 0px 15px rgba(0, 0, 0, 0.1); + box-shadow: 0px 0px 15px rgba(0, 0, 0, 0.1); +} +.navbar-expand-none .navbar-collapse .navbar-nav { + overflow: hidden; + overflow-y: auto; + max-height: 65vh; + padding: 15px; +} +.navbar-expand-none ul.navbar-nav li { + display: block; + border-bottom: 1px solid #eee; + margin: 0; + padding: 0; +} +.navbar-expand-none ul.navbar-nav li:last-child { + border: none; +} +.navbar-expand-none ul.navbar-nav li + li { + margin-left: 0px; +} +.navbar-expand-none ul.navbar-nav li.dropdown > .dropdown-toggle > .arrow.show:after { + -webkit-transform: translate(-50%, -50%) rotate(-45deg); + transform: translate(-50%, -50%) rotate(-45deg); + -webkit-transition: all 0.2s ease; + transition: all 0.2s ease; +} +.navbar-expand-none ul.navbar-nav li > a:hover:after, .navbar-expand-none ul.navbar-nav li > a.active:after { + content: none !important; + width: 0px !important; +} +.navbar-expand-none ul.navbar-nav li.dropdown > .dropdown-toggle .arrow { + display: block; +} +.navbar-expand-none ul.navbar-nav > li > a:not(.btn) { + height: auto; + padding: 8px 0; + position: relative; +} +.navbar-expand-none ul.navbar-nav > li.dropdown .dropdown-menu li > a:not(.btn) { + padding: 8px 0; + position: relative; +} +.navbar-expand-none ul.navbar-nav > li.dropdown:hover > a:after { + content: none; +} +.navbar-expand-none ul.navbar-nav > li.dropdown .dropdown-toggle .arrow:after { + -webkit-transform: translate(-50%, -50%) rotate(134deg); + transform: translate(-50%, -50%) rotate(134deg); + -webkit-transition: all 0.2s ease; + transition: all 0.2s ease; +} +.navbar-expand-none ul.navbar-nav > li.dropdown .dropdown-menu { + margin: 0; + -webkit-box-shadow: none; + box-shadow: none; + border: none; + padding: 0px 0px 0px 15px; +} +.navbar-expand-none ul.navbar-nav > li.dropdown .dropdown-menu .dropdown-menu { + margin: 0; +} +.navbar-expand-none ul.navbar-nav > li.dropdown-mega .dropdown-mega-content > .row > div { + padding: 0px 15px; +} +.navbar-expand-none.navbar-text-light .navbar-collapse { + background: rgba(0, 0, 0, 0.95); +} +.navbar-expand-none.navbar-text-light .navbar-collapse ul.navbar-nav li { + border-color: rgba(250, 250, 250, 0.15); +} +.navbar-expand-none.navbar-dropdown-dark .navbar-collapse { + background-color: #252A2C; +} +.navbar-expand-none.navbar-dropdown-primary .navbar-collapse { + background-color: #0366d6; +} +.navbar-expand-none.navbar-dropdown-primary ul.navbar-nav > li.dropdown .dropdown-menu .dropdown-menu { + background-color: #0366d6; +} +.navbar-expand-none.navbar-dropdown-dark ul.navbar-nav li { + border-color: #444; +} +.navbar-expand-none.navbar-dropdown-dark ul.navbar-nav > li > a { + color: #a3a2a2; +} +.navbar-expand-none.navbar-dropdown-dark ul.navbar-nav > li:hover > a { + color: #fff; +} +.navbar-expand-none.navbar-dropdown-primary ul.navbar-nav li { + border-color: rgba(250, 250, 250, 0.2); +} +.navbar-expand-none.navbar-dropdown-primary ul.navbar-nav > li > a { + color: rgba(250, 250, 250, 0.8); +} +.navbar-expand-none.navbar-dropdown-primary ul.navbar-nav > li:hover > a { + color: #fff; +} + +@media (max-width: 575.98px) { + .navbar-expand-sm .navbar-collapse { + position: absolute; + top: 99%; + right: 0; + left: 0; + background: #fff; + margin-top: 0px; + z-index: 1000; + -webkit-box-shadow: 0px 0px 15px rgba(0, 0, 0, 0.1); + box-shadow: 0px 0px 15px rgba(0, 0, 0, 0.1); + } + .navbar-expand-sm .navbar-collapse .navbar-nav { + overflow: hidden; + overflow-y: auto; + max-height: 65vh; + padding: 15px; + } + .navbar-expand-sm ul.navbar-nav li { + display: block; + border-bottom: 1px solid #eee; + margin: 0; + padding: 0; + } + .navbar-expand-sm ul.navbar-nav li:last-child { + border: none; + } + .navbar-expand-sm ul.navbar-nav li + li { + margin-left: 0px; + } + .navbar-expand-sm ul.navbar-nav li.dropdown > .dropdown-toggle > .arrow.show:after { + -webkit-transform: translate(-50%, -50%) rotate(-45deg); + transform: translate(-50%, -50%) rotate(-45deg); + -webkit-transition: all 0.2s ease; + transition: all 0.2s ease; + } + .navbar-expand-sm ul.navbar-nav li > a:hover:after, .navbar-expand-sm ul.navbar-nav li > a.active:after { + content: none !important; + width: 0px !important; + } + .navbar-expand-sm ul.navbar-nav li.dropdown > .dropdown-toggle .arrow { + display: block; + } + .navbar-expand-sm ul.navbar-nav > li > a:not(.btn) { + height: auto; + padding: 8px 0; + position: relative; + } + .navbar-expand-sm ul.navbar-nav > li.dropdown .dropdown-menu li > a:not(.btn) { + padding: 8px 0; + position: relative; + } + .navbar-expand-sm ul.navbar-nav > li.dropdown:hover > a:after { + content: none; + } + .navbar-expand-sm ul.navbar-nav > li.dropdown .dropdown-toggle .arrow:after { + -webkit-transform: translate(-50%, -50%) rotate(134deg); + transform: translate(-50%, -50%) rotate(134deg); + -webkit-transition: all 0.2s ease; + transition: all 0.2s ease; + } + .navbar-expand-sm ul.navbar-nav > li.dropdown .dropdown-menu { + margin: 0; + -webkit-box-shadow: none; + box-shadow: none; + border: none; + padding: 0px 0px 0px 15px; + } + .navbar-expand-sm ul.navbar-nav > li.dropdown .dropdown-menu .dropdown-menu { + margin: 0; + } + .navbar-expand-sm ul.navbar-nav > li.dropdown-mega .dropdown-mega-content > .row > div { + padding: 0px 15px; + } + .navbar-expand-sm.navbar-text-light .navbar-collapse { + background: rgba(0, 0, 0, 0.95); + } + .navbar-expand-sm.navbar-text-light .navbar-collapse ul.navbar-nav li { + border-color: rgba(250, 250, 250, 0.15); + } + .navbar-expand-sm.navbar-dropdown-dark .navbar-collapse { + background-color: #252A2C; + } + .navbar-expand-sm.navbar-dropdown-primary .navbar-collapse { + background-color: #0366d6; + } + .navbar-expand-sm.navbar-dropdown-primary ul.navbar-nav > li.dropdown .dropdown-menu .dropdown-menu { + background-color: #0366d6; + } + .navbar-expand-sm.navbar-dropdown-dark ul.navbar-nav li { + border-color: #444; + } + .navbar-expand-sm.navbar-dropdown-dark ul.navbar-nav > li > a { + color: #a3a2a2; + } + .navbar-expand-sm.navbar-dropdown-dark ul.navbar-nav > li:hover > a { + color: #fff; + } + .navbar-expand-sm.navbar-dropdown-primary ul.navbar-nav li { + border-color: rgba(250, 250, 250, 0.2); + } + .navbar-expand-sm.navbar-dropdown-primary ul.navbar-nav > li > a { + color: rgba(250, 250, 250, 0.8); + } + .navbar-expand-sm.navbar-dropdown-primary ul.navbar-nav > li:hover > a { + color: #fff; + } +} +@media (max-width: 767.98px) { + .navbar-expand-md .navbar-collapse { + position: absolute; + top: 99%; + right: 0; + left: 0; + background: #fff; + margin-top: 0px; + z-index: 1000; + -webkit-box-shadow: 0px 0px 15px rgba(0, 0, 0, 0.1); + box-shadow: 0px 0px 15px rgba(0, 0, 0, 0.1); + } + .navbar-expand-md .navbar-collapse .navbar-nav { + overflow: hidden; + overflow-y: auto; + max-height: 65vh; + padding: 15px; + } + .navbar-expand-md ul.navbar-nav li { + display: block; + border-bottom: 1px solid #eee; + margin: 0; + padding: 0; + } + .navbar-expand-md ul.navbar-nav li:last-child { + border: none; + } + .navbar-expand-md ul.navbar-nav li + li { + margin-left: 0px; + } + .navbar-expand-md ul.navbar-nav li.dropdown > .dropdown-toggle > .arrow.show:after { + -webkit-transform: translate(-50%, -50%) rotate(-45deg); + transform: translate(-50%, -50%) rotate(-45deg); + -webkit-transition: all 0.2s ease; + transition: all 0.2s ease; + } + .navbar-expand-md ul.navbar-nav li > a:hover:after, .navbar-expand-md ul.navbar-nav li > a.active:after { + content: none !important; + width: 0px !important; + } + .navbar-expand-md ul.navbar-nav li.dropdown > .dropdown-toggle .arrow { + display: block; + } + .navbar-expand-md ul.navbar-nav > li > a:not(.btn) { + height: auto; + padding: 8px 0; + position: relative; + } + .navbar-expand-md ul.navbar-nav > li.dropdown .dropdown-menu li > a:not(.btn) { + padding: 8px 0; + position: relative; + } + .navbar-expand-md ul.navbar-nav > li.dropdown:hover > a:after { + content: none; + } + .navbar-expand-md ul.navbar-nav > li.dropdown .dropdown-toggle .arrow:after { + -webkit-transform: translate(-50%, -50%) rotate(134deg); + transform: translate(-50%, -50%) rotate(134deg); + -webkit-transition: all 0.2s ease; + transition: all 0.2s ease; + } + .navbar-expand-md ul.navbar-nav > li.dropdown .dropdown-menu { + margin: 0; + -webkit-box-shadow: none; + box-shadow: none; + border: none; + padding: 0px 0px 0px 15px; + } + .navbar-expand-md ul.navbar-nav > li.dropdown .dropdown-menu .dropdown-menu { + margin: 0; + } + .navbar-expand-md ul.navbar-nav > li.dropdown-mega .dropdown-mega-content > .row > div { + padding: 0px 15px; + } + .navbar-expand-md.navbar-text-light .navbar-collapse { + background: rgba(0, 0, 0, 0.95); + } + .navbar-expand-md.navbar-text-light .navbar-collapse ul.navbar-nav li { + border-color: rgba(250, 250, 250, 0.15); + } + .navbar-expand-md.navbar-dropdown-dark .navbar-collapse { + background-color: #252A2C; + } + .navbar-expand-md.navbar-dropdown-primary .navbar-collapse { + background-color: #0366d6; + } + .navbar-expand-md.navbar-dropdown-primary ul.navbar-nav > li.dropdown .dropdown-menu .dropdown-menu { + background-color: #0366d6; + } + .navbar-expand-md.navbar-dropdown-dark ul.navbar-nav li { + border-color: #444; + } + .navbar-expand-md.navbar-dropdown-dark ul.navbar-nav > li > a { + color: #a3a2a2; + } + .navbar-expand-md.navbar-dropdown-dark ul.navbar-nav > li:hover > a { + color: #fff; + } + .navbar-expand-md.navbar-dropdown-primary ul.navbar-nav li { + border-color: rgba(250, 250, 250, 0.2); + } + .navbar-expand-md.navbar-dropdown-primary ul.navbar-nav > li > a { + color: rgba(250, 250, 250, 0.8); + } + .navbar-expand-md.navbar-dropdown-primary ul.navbar-nav > li:hover > a { + color: #fff; + } +} +@media (max-width: 991.98px) { + .navbar-expand-lg .navbar-collapse { + position: absolute; + top: 99%; + right: 0; + left: 0; + background: #fff; + margin-top: 0px; + z-index: 1000; + -webkit-box-shadow: 0px 0px 15px rgba(0, 0, 0, 0.1); + box-shadow: 0px 0px 15px rgba(0, 0, 0, 0.1); + } + .navbar-expand-lg .navbar-collapse .navbar-nav { + overflow: hidden; + overflow-y: auto; + max-height: 65vh; + padding: 15px; + } + .navbar-expand-lg ul.navbar-nav li { + display: block; + border-bottom: 1px solid #eee; + margin: 0; + padding: 0; + } + .navbar-expand-lg ul.navbar-nav li:last-child { + border: none; + } + .navbar-expand-lg ul.navbar-nav li + li { + margin-left: 0px; + } + .navbar-expand-lg ul.navbar-nav li.dropdown > .dropdown-toggle > .arrow.show:after { + -webkit-transform: translate(-50%, -50%) rotate(-45deg); + transform: translate(-50%, -50%) rotate(-45deg); + -webkit-transition: all 0.2s ease; + transition: all 0.2s ease; + } + .navbar-expand-lg ul.navbar-nav li > a:hover:after, .navbar-expand-lg ul.navbar-nav li > a.active:after { + content: none !important; + width: 0px !important; + } + .navbar-expand-lg ul.navbar-nav li.dropdown > .dropdown-toggle .arrow { + display: block; + } + .navbar-expand-lg ul.navbar-nav > li > a:not(.btn) { + height: auto; + padding: 8px 0; + position: relative; + } + .navbar-expand-lg ul.navbar-nav > li.dropdown .dropdown-menu li > a:not(.btn) { + padding: 8px 0; + position: relative; + } + .navbar-expand-lg ul.navbar-nav > li.dropdown:hover > a:after { + content: none; + } + .navbar-expand-lg ul.navbar-nav > li.dropdown .dropdown-toggle .arrow:after { + -webkit-transform: translate(-50%, -50%) rotate(134deg); + transform: translate(-50%, -50%) rotate(134deg); + -webkit-transition: all 0.2s ease; + transition: all 0.2s ease; + } + .navbar-expand-lg ul.navbar-nav > li.dropdown .dropdown-menu { + margin: 0; + -webkit-box-shadow: none; + box-shadow: none; + border: none; + padding: 0px 0px 0px 15px; + } + .navbar-expand-lg ul.navbar-nav > li.dropdown .dropdown-menu .dropdown-menu { + margin: 0; + } + .navbar-expand-lg ul.navbar-nav > li.dropdown-mega .dropdown-mega-content > .row > div { + padding: 0px 15px; + } + .navbar-expand-lg.navbar-text-light .navbar-collapse { + background: rgba(0, 0, 0, 0.95); + } + .navbar-expand-lg.navbar-text-light .navbar-collapse ul.navbar-nav li { + border-color: rgba(250, 250, 250, 0.15); + } + .navbar-expand-lg.navbar-dropdown-dark .navbar-collapse { + background-color: #252A2C; + } + .navbar-expand-lg.navbar-dropdown-primary .navbar-collapse { + background-color: #0366d6; + } + .navbar-expand-lg.navbar-dropdown-primary ul.navbar-nav > li.dropdown .dropdown-menu .dropdown-menu { + background-color: #0366d6; + } + .navbar-expand-lg.navbar-dropdown-dark ul.navbar-nav li { + border-color: #444; + } + .navbar-expand-lg.navbar-dropdown-dark ul.navbar-nav > li > a { + color: #a3a2a2; + } + .navbar-expand-lg.navbar-dropdown-dark ul.navbar-nav > li:hover > a { + color: #fff; + } + .navbar-expand-lg.navbar-dropdown-primary ul.navbar-nav li { + border-color: rgba(250, 250, 250, 0.2); + } + .navbar-expand-lg.navbar-dropdown-primary ul.navbar-nav > li > a { + color: rgba(250, 250, 250, 0.8); + } + .navbar-expand-lg.navbar-dropdown-primary ul.navbar-nav > li:hover > a { + color: #fff; + } +} +@media (max-width: 1199.98px) { + .navbar-expand-xl .navbar-collapse { + position: absolute; + top: 99%; + right: 0; + left: 0; + background: #fff; + margin-top: 0px; + z-index: 1000; + -webkit-box-shadow: 0px 0px 15px rgba(0, 0, 0, 0.1); + box-shadow: 0px 0px 15px rgba(0, 0, 0, 0.1); + } + .navbar-expand-xl .navbar-collapse .navbar-nav { + overflow: hidden; + overflow-y: auto; + max-height: 65vh; + padding: 15px; + } + .navbar-expand-xl ul.navbar-nav li { + display: block; + border-bottom: 1px solid #eee; + margin: 0; + padding: 0; + } + .navbar-expand-xl ul.navbar-nav li:last-child { + border: none; + } + .navbar-expand-xl ul.navbar-nav li + li { + margin-left: 0px; + } + .navbar-expand-xl ul.navbar-nav li.dropdown > .dropdown-toggle > .arrow.show:after { + -webkit-transform: translate(-50%, -50%) rotate(-45deg); + transform: translate(-50%, -50%) rotate(-45deg); + -webkit-transition: all 0.2s ease; + transition: all 0.2s ease; + } + .navbar-expand-xl ul.navbar-nav li > a:hover:after, .navbar-expand-xl ul.navbar-nav li > a.active:after { + content: none !important; + width: 0px !important; + } + .navbar-expand-xl ul.navbar-nav li.dropdown > .dropdown-toggle .arrow { + display: block; + } + .navbar-expand-xl ul.navbar-nav > li > a:not(.btn) { + height: auto; + padding: 8px 0; + position: relative; + } + .navbar-expand-xl ul.navbar-nav > li.dropdown .dropdown-menu li > a:not(.btn) { + padding: 8px 0; + position: relative; + } + .navbar-expand-xl ul.navbar-nav > li.dropdown:hover > a:after { + content: none; + } + .navbar-expand-xl ul.navbar-nav > li.dropdown .dropdown-toggle .arrow:after { + -webkit-transform: translate(-50%, -50%) rotate(134deg); + transform: translate(-50%, -50%) rotate(134deg); + -webkit-transition: all 0.2s ease; + transition: all 0.2s ease; + } + .navbar-expand-xl ul.navbar-nav > li.dropdown .dropdown-menu { + margin: 0; + -webkit-box-shadow: none; + box-shadow: none; + border: none; + padding: 0px 0px 0px 15px; + } + .navbar-expand-xl ul.navbar-nav > li.dropdown .dropdown-menu .dropdown-menu { + margin: 0; + } + .navbar-expand-xl ul.navbar-nav > li.dropdown-mega .dropdown-mega-content > .row > div { + padding: 0px 15px; + } + .navbar-expand-xl.navbar-text-light .navbar-collapse { + background: rgba(0, 0, 0, 0.95); + } + .navbar-expand-xl.navbar-text-light .navbar-collapse ul.navbar-nav li { + border-color: rgba(250, 250, 250, 0.15); + } + .navbar-expand-xl.navbar-dropdown-dark .navbar-collapse { + background-color: #252A2C; + } + .navbar-expand-xl.navbar-dropdown-primary .navbar-collapse { + background-color: #0366d6; + } + .navbar-expand-xl.navbar-dropdown-primary ul.navbar-nav > li.dropdown .dropdown-menu .dropdown-menu { + background-color: #0366d6; + } + .navbar-expand-xl.navbar-dropdown-dark ul.navbar-nav li { + border-color: #444; + } + .navbar-expand-xl.navbar-dropdown-dark ul.navbar-nav > li > a { + color: #a3a2a2; + } + .navbar-expand-xl.navbar-dropdown-dark ul.navbar-nav > li:hover > a { + color: #fff; + } + .navbar-expand-xl.navbar-dropdown-primary ul.navbar-nav li { + border-color: rgba(250, 250, 250, 0.2); + } + .navbar-expand-xl.navbar-dropdown-primary ul.navbar-nav > li > a { + color: rgba(250, 250, 250, 0.8); + } + .navbar-expand-xl.navbar-dropdown-primary ul.navbar-nav > li:hover > a { + color: #fff; + } +} +/* =================================== */ +/* 5. Elements +/* =================================== */ +/*=== 5.1 List Style ===*/ +.list-style-1 > li { + position: relative; + list-style-type: none; + line-height: 24px; +} +.list-style-1 > li:after { + content: " "; + position: absolute; + top: 12px; + left: -15px; + border-color: #000; + border-top: 1px solid; + border-right: 1px solid; + width: 6px; + height: 6px; + -webkit-transform: translate(-50%, -50%) rotate(45deg); + transform: translate(-50%, -50%) rotate(45deg); +} + +.list-style-2 { + padding: 0; +} + +.list-style-2 > li { + list-style-type: none; + border-bottom: 1px solid #eaeaea; + padding-top: 12px; + padding-bottom: 12px; +} + +.list-style-2.list-style-light > li { + border-bottom: 1px solid rgba(250, 250, 250, 0.12); +} + +/*=== 5.2 Changelog ===*/ +.changelog { + list-style: none; + padding: 0; +} +.changelog .badge { + width: 90px; + margin-right: 10px; + border-radius: .20rem; + text-transform: uppercase; +} +.changelog li { + line-height: 1.8; +} + +/*=== 5.3 Accordion & Toggle ===*/ +.accordion .card { + border: none; + margin-bottom: 16px; + margin-bottom: 1rem; + background-color: transparent; +} +.accordion .card-header { + padding: 0; + border: none; + background: none; +} +.accordion .card-header a { + font-size: 16px; + font-weight: normal; + padding: 1rem 1.25rem 1rem 2.25rem; + display: block; + border-radius: 4px; + position: relative; +} +.accordion .card-header a:hover { + text-decoration: none; +} +.accordion .card-header a:hover.collapsed { + color: #0366d6 !important; +} +.accordion:not(.accordion-alternate) .card-header a { + background-color: #76ace8; + color: #fff; +} +.accordion:not(.accordion-alternate) .card-header a.collapsed { + background-color: #f1f2f4; + color: #4c4d4d; +} +.accordion .card-header a:before { + position: absolute; + content: " "; + left: 20px; + top: calc(50% + 2px); + width: 9px; + height: 9px; + border-color: #CCC; + border-top: 2px solid; + border-right: 2px solid; + -webkit-transform: translate(-50%, -50%) rotate(-45deg); + transform: translate(-50%, -50%) rotate(-45deg); + -webkit-transition: all 0.2s ease; + transition: all 0.2s ease; + -webkit-backface-visibility: hidden; + backface-visibility: hidden; +} +.accordion .card-header a.collapsed:before { + top: calc(50% - 2px); + -webkit-transform: translate(-50%, -50%) rotate(135deg); + transform: translate(-50%, -50%) rotate(135deg); +} +.accordion .card-body { + line-height: 26px; + border: 1px solid #ccc; + margin-top: -4px; + border-radius: 4px; +} +.accordion.arrow-right .card-header a { + padding-left: 1.25rem; +} +.accordion.arrow-right .card-header a:before { + right: 15px; + left: auto; +} +.accordion.accordion-alternate .card { + margin: 0; +} +.accordion.accordion-alternate .card-header a { + padding-left: 1.40rem; + border-top: 1px solid #e4e9ec; + border-radius: 0px; +} +.accordion.accordion-alternate .card:first-of-type .card-header a { + border-top: 0px; +} +.accordion.accordion-alternate .card-header a:before { + left: 6px; +} +.accordion.accordion-alternate .card-header a.collapsed { + color: #4c4d4d; +} +.accordion.accordion-alternate .card-body { + padding: 0rem 0 1rem 1.25rem; +} +.accordion.accordion-alternate.arrow-right .card-header a { + padding-left: 0; +} +.accordion.accordion-alternate.arrow-right .card-header a:before { + right: 0px; + left: auto; +} +.accordion.toggle .card-header a:before { + content: "-"; + border: none; + font-size: 20px; + height: auto; + top: calc(50% + 2px); + width: auto; + -webkit-transform: translate(-50%, -50%) rotate(180deg); + transform: translate(-50%, -50%) rotate(180deg); +} +.accordion.toggle .card-header a.collapsed:before { + content: "+"; + top: calc(50% - 1px); + -webkit-transform: translate(-50%, -50%) rotate(0deg); + transform: translate(-50%, -50%) rotate(0deg); +} +.accordion.accordion-alternate.style-2 .card-header a { + padding-left: 0px; +} +.accordion.accordion-alternate.style-2 .card-header a:before { + right: 2px; + left: auto; + -webkit-transform: translate(-50%, -50%) rotate(135deg); + transform: translate(-50%, -50%) rotate(135deg); + top: 50%; +} +.accordion.accordion-alternate.style-2 .card-header a.collapsed:before { + -webkit-transform: translate(-50%, -50%) rotate(45deg); + transform: translate(-50%, -50%) rotate(45deg); +} +.accordion.accordion-alternate.style-2 .card-body { + padding-left: 0px; +} +.accordion.accordion-alternate.popularRoutes .card-header .nav { + margin-top: 3px; +} +.accordion.accordion-alternate.popularRoutes .card-header .nav a { + font-size: 14px; +} +.accordion.accordion-alternate.popularRoutes .card-header a { + padding: 0px 8px 0px 0px; + border: none; + font-size: inherit; +} +.accordion.accordion-alternate.popularRoutes .card-header a:before { + content: none; +} +.accordion.accordion-alternate.popularRoutes .card-header h5 { + cursor: pointer; +} +.accordion.accordion-alternate.popularRoutes .card-header h5:before { + position: absolute; + content: " "; + right: 0px; + top: 24px; + width: 10px; + height: 10px; + opacity: 0.6; + border-top: 2px solid; + border-right: 2px solid; + -webkit-transform: translate(-50%, -50%) rotate(-45deg); + transform: translate(-50%, -50%) rotate(-45deg); + -webkit-transition: all 0.2s ease; + transition: all 0.2s ease; + -webkit-backface-visibility: hidden; + backface-visibility: hidden; +} +.accordion.accordion-alternate.popularRoutes .card-header h5.collapsed:before { + top: 24px; + -webkit-transform: translate(-50%, -50%) rotate(135deg); + transform: translate(-50%, -50%) rotate(135deg); +} +.accordion.accordion-alternate.popularRoutes .card-body { + padding: 0; +} +.accordion.accordion-alternate.popularRoutes .card { + border-bottom: 2px solid #e4e9ec; + padding: 15px 0px; +} +.accordion.accordion-alternate.popularRoutes .routes-list { + margin: 1rem 0px 0px 0px; + padding: 0px; + list-style: none; +} +.accordion.accordion-alternate.popularRoutes .routes-list a { + color: inherit; + display: -ms-flexbox !important; + display: flex !important; + -ms-flex-align: center !important; + align-items: center !important; +} +.accordion.accordion-alternate.popularRoutes .routes-list a:hover { + color: #0071cc; + text-decoration: underline; +} + +/* 5.4 Nav */ +.nav .nav-item .nav-link { + color: #222222; +} + +.nav.nav-light .nav-item .nav-link { + color: #ddd; +} + +.nav:not(.nav-pills) .nav-item .nav-link.active, .nav:not(.nav-pills) .nav-item .nav-link:hover { + color: #0366d6; +} + +.nav-pills .nav-link:not(.active):hover { + color: #0366d6; +} + +.nav-pills .nav-link.active, .nav-pills.nav-light .nav-link.active, .nav-pills .show > .nav-link { + color: #fff; +} + +.nav.nav-separator .nav-item .nav-link { + position: relative; +} + +.nav.nav-separator .nav-item + .nav-item .nav-link:after { + height: 14px; + width: 1px; + content: ' '; + background-color: rgba(0, 0, 0, 0.2); + display: block; + position: absolute; + top: 50%; + left: 0; + -webkit-transform: translateY(-7px); + transform: translateY(-7px); +} + +.nav.nav-separator.nav-separator-light .nav-item + .nav-item .nav-link:after { + background-color: rgba(250, 250, 250, 0.2); +} + +.nav.nav-sm .nav-item .nav-link { + font-size: 14px; +} + +/*=== 5.5 Tabs ===*/ +.nav-tabs { + border-bottom: 1px solid #d7dee3; + padding-bottom: 16px; +} +.nav-tabs .nav-item .nav-link { + border: 0; + background: transparent; + position: relative; + border-radius: 0; + padding: 0.6rem 1rem; + color: #7b8084; + white-space: nowrap !important; +} +.nav-tabs .nav-item .nav-link.active { + color: #0c2f55; +} +.nav-tabs .nav-item .nav-link.active:after { + height: 2px; + width: 100%; + content: ' '; + background-color: #0366d6; + display: block; + position: absolute; + bottom: -3px; + left: 0; + -webkit-transform: translateY(-3px); + transform: translateY(-3px); +} +.nav-tabs .nav-item .nav-link:not(.active):after { + height: 2px; + width: calc(100% - 10px); + content: ' '; + background-color: #aaa; + display: block; + margin: 0 5px; + position: absolute; + bottom: -3px; + left: 0; + -webkit-transform: translateY(-3px); + transform: translateY(-3px); +} +.nav-tabs .nav-item .nav-link:not(.active):hover { + color: #0366d6; +} +.nav-tabs.flex-column { + border-right: 1px solid #d7dee3; + border-bottom: 0px; + padding: 1.5rem 0; +} +.nav-tabs.flex-column .nav-item .nav-link { + border: 1px solid #d7dee3; + border-right: 0px; + background-color: #f6f7f8; + font-size: 14px; + padding: 0.75rem 1rem; + color: #535b61; +} +.nav-tabs.flex-column .nav-item:first-of-type .nav-link { + border-top-left-radius: 4px; +} +.nav-tabs.flex-column .nav-item:last-of-type .nav-link { + border-bottom-left-radius: 4px; +} +.nav-tabs.flex-column .nav-item .nav-link.active { + background-color: transparent; + color: #0366d6; +} +.nav-tabs.flex-column .nav-item .nav-link.active:after { + height: 100%; + width: 2px; + background: #fff; + right: -1px; + left: auto; +} + +.nav-tabs:not(.flex-column) { + overflow: hidden; + overflow-x: auto; + -ms-overflow-style: -ms-autohiding-scrollbar; + -webkit-overflow-scrolling: touch; +} +.nav-tabs:not(.flex-column) .nav-item { + margin-bottom: 0px; +} + +@media (max-width: 575.98px) { + .nav-tabs .nav-item .nav-link { + padding-left: 0px; + padding-right: 0px; + margin-right: 10px; + font-size: 0.875rem; + } +} +/*=== 5.6 Popup Img ===*/ +.popup-img img { + -webkit-transition: all 0.2s ease-in-out; + transition: all 0.2s ease-in-out; +} + +.popup-img:hover img { + opacity: 0.8; + cursor: -webkit-zoom-in; + cursor: -moz-zoom-in; + cursor: zoom-in; +} + +/*=== 5.7 Featured Box ===*/ +.featured-box { + box-sizing: border-box; + position: relative; +} +.featured-box h3, .featured-box h4 { + font-size: 1.25rem; + font-size: 20px; + margin-bottom: 10px; + font-weight: 500; +} +.featured-box:not(.style-5) .featured-box-icon { + display: inline-block; + font-size: 48px; + min-width: 55px; + min-height: 55px; + padding: 0; + margin-top: 0; + margin-bottom: 0.8rem; + color: #4c4d4d; + border-radius: 0; +} +.featured-box.style-1, .featured-box.style-2, .featured-box.style-3 { + padding-left: 50px; + padding-top: 8px; +} +.featured-box.style-1 .featured-box-icon, .featured-box.style-2 .featured-box-icon, .featured-box.style-3 .featured-box-icon { + position: absolute; + top: 0; + left: 0; + margin-bottom: 0; + font-size: 30px; + -ms-flex-pack: center !important; + justify-content: center !important; + text-align: center; +} +.featured-box.style-2 p { + margin-left: -50px; +} +.featured-box.style-3 { + padding-left: 90px; + padding-top: 0px; +} +.featured-box.style-3 .featured-box-icon { + width: 70px; + height: 70px; + -ms-flex-negative: 0; + flex-shrink: 0; + display: -webkit-box; + display: -ms-flexbox; + display: flex; + -webkit-box-align: center; + -ms-flex-align: center; + align-items: center; +} +.featured-box.style-4 { + text-align: center; +} +.featured-box.style-4 .featured-box-icon { + margin: 0 auto 24px; + margin: 0 auto 1.5rem; + width: 120px; + height: 120px; + text-align: center; + -ms-flex-negative: 0; + flex-shrink: 0; + display: -webkit-box; + display: -ms-flexbox; + display: flex; + -webkit-box-align: center; + -ms-flex-align: center; + align-items: center; + -ms-flex-pack: center; + justify-content: center; + -webkit-box-shadow: 0px 0px 50px rgba(0, 0, 0, 0.03); + box-shadow: 0px 0px 50px rgba(0, 0, 0, 0.03); +} +.featured-box.style-5 { + text-align: center; + background: #fff; + border: 1px solid #f0f2f3; + -webkit-box-shadow: 0px 2px 5px rgba(0, 0, 0, 0.05); + box-shadow: 0px 2px 5px rgba(0, 0, 0, 0.05); + -webkit-transition: all 0.3s ease-in-out; + transition: all 0.3s ease-in-out; +} +.featured-box.style-5:hover { + border: 1px solid #ebeded; + -webkit-box-shadow: 0px 5px 1.5rem rgba(0, 0, 0, 0.15); + box-shadow: 0px 5px 1.5rem rgba(0, 0, 0, 0.15); +} +.featured-box.style-5 h3 { + background: #f1f5f6; + font-size: 16px; + padding: 8px 0; + margin-bottom: 0px; +} +.featured-box.style-5 .featured-box-icon { + font-size: 50px; + margin: 44px 0px; +} + +.featured-box.featured-box-reverse { + text-align: right; +} +.featured-box.featured-box-reverse.style-1, .featured-box.featured-box-reverse.style-2 { + padding-right: 50px; + padding-left: 0px; +} +.featured-box.featured-box-reverse.style-1 .featured-box-icon, .featured-box.featured-box-reverse.style-2 .featured-box-icon { + left: auto; + right: 0px; +} +.featured-box.featured-box-reverse.style-2 p { + margin-right: -50px; + margin-left: 0; +} +.featured-box.featured-box-reverse.style-3 { + padding-left: 0; + padding-right: 90px; +} +.featured-box.featured-box-reverse.style-3 .featured-box-icon { + left: auto; + right: 0px; +} + +.featured-box.featured-box-reverse-sm { + text-align: right; +} +.featured-box.featured-box-reverse-sm.style-1, .featured-box.featured-box-reverse-sm.style-2 { + padding-right: 50px; + padding-left: 0px; +} +.featured-box.featured-box-reverse-sm.style-1 .featured-box-icon, .featured-box.featured-box-reverse-sm.style-2 .featured-box-icon { + left: auto; + right: 0px; +} +.featured-box.featured-box-reverse-sm.style-2 p { + margin-right: -50px; + margin-left: 0; +} +.featured-box.featured-box-reverse-sm.style-3 { + padding-left: 0; + padding-right: 90px; +} +.featured-box.featured-box-reverse-sm.style-3 .featured-box-icon { + left: auto; + right: 0px; +} + +@media (min-width: 576px) { + .featured-box.featured-box-reverse-md { + text-align: right; + } + .featured-box.featured-box-reverse-md.style-1, .featured-box.featured-box-reverse-md.style-2 { + padding-right: 50px; + padding-left: 0px; + } + .featured-box.featured-box-reverse-md.style-1 .featured-box-icon, .featured-box.featured-box-reverse-md.style-2 .featured-box-icon { + left: auto; + right: 0px; + } + .featured-box.featured-box-reverse-md.style-2 p { + margin-right: -50px; + margin-left: 0; + } + .featured-box.featured-box-reverse-md.style-3 { + padding-left: 0; + padding-right: 90px; + } + .featured-box.featured-box-reverse-md.style-3 .featured-box-icon { + left: auto; + right: 0px; + } +} +@media (min-width: 768px) { + .featured-box.featured-box-reverse-lg { + text-align: right; + } + .featured-box.featured-box-reverse-lg.style-1, .featured-box.featured-box-reverse-lg.style-2 { + padding-right: 50px; + padding-left: 0px; + } + .featured-box.featured-box-reverse-lg.style-1 .featured-box-icon, .featured-box.featured-box-reverse-lg.style-2 .featured-box-icon { + left: auto; + right: 0px; + } + .featured-box.featured-box-reverse-lg.style-2 p { + margin-right: -50px; + margin-left: 0; + } + .featured-box.featured-box-reverse-lg.style-3 { + padding-left: 0; + padding-right: 90px; + } + .featured-box.featured-box-reverse-lg.style-3 .featured-box-icon { + left: auto; + right: 0px; + } +} +@media (min-width: 992px) { + .featured-box.featured-box-reverse-xl { + text-align: right; + } + .featured-box.featured-box-reverse-xl.style-1, .featured-box.featured-box-reverse-xl.style-2 { + padding-right: 50px; + padding-left: 0px; + } + .featured-box.featured-box-reverse-xl.style-1 .featured-box-icon, .featured-box.featured-box-reverse-xl.style-2 .featured-box-icon { + left: auto; + right: 0px; + } + .featured-box.featured-box-reverse-xl.style-2 p { + margin-right: -50px; + margin-left: 0; + } + .featured-box.featured-box-reverse-xl.style-3 { + padding-left: 0; + padding-right: 90px; + } + .featured-box.featured-box-reverse-xl.style-3 .featured-box-icon { + left: auto; + right: 0px; + } +} +/* =================================== */ +/* 6. Footer +/* =================================== */ +#footer { + background: #fff; + color: #252b33; + margin-left: 260px; + padding: 66px 0px; + padding: 4.125rem 0; +} +#footer .nav .nav-item { + display: inline-block; + line-height: 12px; + margin: 0; +} +#footer .nav .nav-item .nav-link { + color: #252b33; + -webkit-transition: all 0.2s ease; + transition: all 0.2s ease; +} +#footer .nav .nav-item .nav-link:focus { + color: #0366d6; + -webkit-transition: all 0.2s ease; + transition: all 0.2s ease; +} +#footer .nav .nav-item:first-child .nav-link { + padding-left: 0px; +} +#footer .nav .nav-item:last-child .nav-link { + padding-right: 0px; +} +#footer .nav .nav-link:hover { + color: #0366d6; + -webkit-transition: all 0.2s ease; + transition: all 0.2s ease; +} +#footer .footer-copyright { + border-top: 1px solid #e2e8ea; + padding: 0px 0px; + color: #67727c; +} +#footer .footer-copyright .nav .nav-item .nav-link { + color: #67727c; +} +#footer .footer-copyright .nav .nav-link:hover { + color: #0366d6; + -webkit-transition: all 0.2s ease; + transition: all 0.2s ease; +} +#footer .nav.flex-column .nav-item { + padding: 0px; +} +#footer .nav.flex-column .nav-item .nav-link { + margin: 0.7rem 0px; +} +#footer.footer-text-light { + color: rgba(250, 250, 250, 0.8); +} +#footer.footer-text-light .nav .nav-item .nav-link { + color: rgba(250, 250, 250, 0.8); +} +#footer.footer-text-light .nav .nav-item .nav-link:hover { + color: #fafafa; +} +#footer.footer-text-light .footer-copyright { + border-color: rgba(250, 250, 250, 0.15); + color: rgba(250, 250, 250, 0.5); +} +#footer.footer-text-light:not(.bg-primary) .social-icons-light.social-icons li a { + color: rgba(250, 250, 250, 0.8); +} +#footer.footer-text-light:not(.bg-primary) .social-icons-light.social-icons li a:hover { + color: #fafafa; +} +#footer.footer-text-light.bg-primary { + color: #fff; +} +#footer.footer-text-light.bg-primary .nav .nav-item .nav-link { + color: #fff; +} +#footer.footer-text-light.bg-primary .nav .nav-item .nav-link:hover { + color: rgba(250, 250, 250, 0.7); +} +#footer.footer-text-light.bg-primary .footer-copyright { + border-color: rgba(250, 250, 250, 0.15); + color: rgba(250, 250, 250, 0.9); +} +#footer.footer-text-light.bg-primary :not(.social-icons) a { + color: #fff; +} +#footer.footer-text-light.bg-primary :not(.social-icons) a:hover { + color: rgba(250, 250, 250, 0.7); +} + +@media (max-width: 767.98px) { + #footer { + margin-left: 0px; + } +} +/*=== 6.1 Social Icons ===*/ +.social-icons { + margin: 0; + padding: 0; + display: -ms-flexbox; + display: flex; + -ms-flex-wrap: wrap; + flex-wrap: wrap; + list-style: none; +} +.social-icons li { + margin: 0px 6px; + padding: 0; + overflow: visible; +} +.social-icons-nuget{ + margin-right: 24px !important; +} +.social-icons li a { + display: block; + height: 26px; + line-height: 26px; + width: 26px; + font-size: 18px; + text-align: center; + color: #4d555a; + text-decoration: none; + -webkit-transition: all 0.2s ease; + transition: all 0.2s ease; +} +.social-icons li i { + line-height: inherit; +} +.social-icons.social-icons-sm li { + margin: 0px 4px; +} +.social-icons.social-icons-sm li a { + font-size: 15px; + width: 22px; +} +.social-icons.social-icons-lg li a { + width: 34px; + height: 34px; + line-height: 34px; + font-size: 22px; +} +.social-icons.social-icons-light li a { + color: #eee; +} +.social-icons.social-icons-muted li a { + color: #aab1b8; +} +.social-icons li:hover a { + color: #999; +} + +/*=== 6.2 Back to Top ===*/ +#back-to-top { + display: none; + position: fixed; + z-index: 1030; + bottom: 8px; + right: 10px; + background-color: rgba(0, 0, 0, 0.22); + text-align: center; + color: #fff; + font-size: 14px; + width: 36px; + height: 36px; + line-height: 34px; + border-radius: 3px; + -webkit-transition: all 0.3s ease-in-out; + transition: all 0.3s ease-in-out; + -webkit-box-shadow: 0px 5px 15px rgba(0, 0, 0, 0.15); + box-shadow: 0px 5px 15px rgba(0, 0, 0, 0.15); +} +#back-to-top:hover { + background-color: #0366d6; + -webkit-box-shadow: 0px 5px 15px rgba(0, 0, 0, 0.25); + box-shadow: 0px 5px 15px rgba(0, 0, 0, 0.25); + -webkit-transition: all 0.3s ease-in-out; + transition: all 0.3s ease-in-out; +} + +@media (max-width: 575.98px) { + #back-to-top { + z-index: 1029; + } +} +/* =================================== */ +/* Extras +/* =================================== */ +/* Bootstrap Specific */ +.form-control, .custom-select { + border-color: #dae1e3; + font-size: 16px; + color: #656565; +} + +.form-control:not(.form-control-sm) { + padding: .810rem .96rem; + height: inherit; +} + +.form-control-sm { + font-size: 14px; +} + +.icon-inside { + position: absolute; + right: 15px; + top: calc(50% - 11px); + pointer-events: none; + font-size: 18px; + font-size: 1.125rem; + color: #c4c3c3; + z-index: 3; +} + +.form-control-sm + .icon-inside { + font-size: 0.875rem !important; + font-size: 14px; + top: calc(50% - 13px); +} + +select.form-control:not([size]):not([multiple]):not(.form-control-sm) { + height: auto; + padding-top: .700rem; + padding-bottom: .700rem; +} + +.custom-select:not(.custom-select-sm) { + height: calc(3.05rem + 2px); + padding-top: .700rem; + padding-bottom: .700rem; +} + +.col-form-label-sm { + font-size: 13px; +} + +.custom-select-sm { + padding-left: 5px !important; + font-size: 14px; +} + +.custom-select:not(.custom-select-sm).border-0 { + height: 3.00rem; +} + +.form-control:focus, .custom-select:focus { + -webkit-box-shadow: 0 0 5px rgba(128, 189, 255, 0.5); + box-shadow: 0 0 5px rgba(128, 189, 255, 0.5); +} + +.form-control:focus[readonly] { + box-shadow: none; +} + +.input-group-text { + border-color: #dae1e3; + background-color: #f1f5f6; + color: #656565; +} + +.form-control::-webkit-input-placeholder { + color: #b1b4b6; +} +.form-control:-moz-placeholder { + /* FF 4-18 */ + color: #b1b4b6; +} +.form-control::-moz-placeholder { + /* FF 19+ */ + color: #b1b4b6; +} +.form-control:-ms-input-placeholder, .form-control::-ms-input-placeholder { + /* IE 10+ */ + color: #b1b4b6; +} + +/* Form Dark */ +.form-dark .form-control, .form-dark .custom-select { + border-color: #232a31; + background: #232a31; + color: #fff; +} +.form-dark .form-control:focus { + border-color: #80bdff !important; +} +.form-dark .form-control::-webkit-input-placeholder { + color: #777b7f; +} +.form-dark .form-control:-moz-placeholder { + /* FF 4-18 */ + color: #777b7f; +} +.form-dark .form-control::-moz-placeholder { + /* FF 19+ */ + color: #777b7f; +} +.form-dark .form-control:-ms-input-placeholder, .form-dark .form-control::-ms-input-placeholder { + /* IE 10+ */ + color: #777b7f; +} +.form-dark .custom-select { + color: #777b7f; + background: url("data:image/svg+xml;charset=utf8,%3Csvg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 4 5'%3E%3Cpath fill='rgba(250,250,250,0.3)' d='M2 0L0 2h4zm0 5L0 3h4z'/%3E%3C/svg%3E") no-repeat right 0.75rem center; + background-size: 13px 15px; + border-color: #232a31; + background-color: #232a31; +} +.form-dark .icon-inside { + color: #777b7f; +} + +/* Input with only bottom border */ +.form-border .form-control { + background-color: transparent; + border: none; + border-bottom: 2px solid rgba(0, 0, 0, 0.12); + border-radius: 0px; + padding-left: 0px !important; + color: black; +} +.form-border .form-control::-webkit-input-placeholder { + color: rgba(0, 0, 0, 0.4); +} +.form-border .form-control:-moz-placeholder { + /* FF 4-18 */ + color: rgba(0, 0, 0, 0.4); +} +.form-border .form-control::-moz-placeholder { + /* FF 19+ */ + color: rgba(0, 0, 0, 0.4); +} +.form-border .form-control:-ms-input-placeholder, .form-border .form-control::-ms-input-placeholder { + /* IE 10+ */ + color: rgba(0, 0, 0, 0.4); +} +.form-border .custom-select { + background-color: transparent; + border: none; + border-bottom: 2px solid rgba(0, 0, 0, 0.12); + border-radius: 0px; + padding-left: 0px; + color: rgba(0, 0, 0, 0.4); + background: url("data:image/svg+xml;charset=utf8,%3Csvg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 4 5'%3E%3Cpath fill='rgba(0,0,0,0.3)' d='M2 0L0 2h4zm0 5L0 3h4z'/%3E%3C/svg%3E") no-repeat right 0.75rem center; + background-size: 13px 15px; +} +.form-border .form-control:focus, .form-border .custom-select:focus { + box-shadow: none; + -webkit-box-shadow: none; + border-bottom: 2px solid rgba(0, 0, 0, 0.7); +} +.form-border .form-control:not(output):-moz-ui-invalid:not(:focus), .form-border .form-control:not(output):-moz-ui-invalid:-moz-focusring:not(:focus), .form-border .custom-select:not(output):-moz-ui-invalid:not(:focus), .form-border .custom-select:not(output):-moz-ui-invalid:-moz-focusring:not(:focus) { + border-bottom: 2px solid #b00708; + box-shadow: none; + -webkit-box-shadow: none; +} +.form-border .icon-inside { + color: rgba(0, 0, 0, 0.25); +} +.form-border select option { + color: #666; +} + +.form-border-light .form-control { + border-bottom: 2px solid rgba(250, 250, 250, 0.3); + color: #fafafa; +} +.form-border-light .form-control::-webkit-input-placeholder { + color: rgba(250, 250, 250, 0.7); +} +.form-border-light .form-control:-moz-placeholder { + /* FF 4-18 */ + color: rgba(250, 250, 250, 0.7); +} +.form-border-light .form-control::-moz-placeholder { + /* FF 19+ */ + color: rgba(250, 250, 250, 0.7); +} +.form-border-light .form-control:-ms-input-placeholder, .form-border-light .form-control::-ms-input-placeholder { + /* IE 10+ */ + color: rgba(250, 250, 250, 0.7); +} +.form-border-light .custom-select { + border-bottom: 2px solid rgba(250, 250, 250, 0.3); + color: #fafafa; + background: url("data:image/svg+xml;charset=utf8,%3Csvg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 4 5'%3E%3Cpath fill='rgba(250,250,250,0.6)' d='M2 0L0 2h4zm0 5L0 3h4z'/%3E%3C/svg%3E") no-repeat right 0.75rem center; + background-size: 13px 15px; +} +.form-border-light .form-control:focus, .form-border-light .custom-select:focus { + border-bottom: 2px solid rgba(250, 250, 250, 0.8); +} +.form-border-light .icon-inside { + color: #999; +} +.form-border-light select option { + color: #333; +} + +.input-group-append .btn, .input-group-prepend .btn { + -webkit-box-shadow: none; + box-shadow: none; + padding-left: 0.75rem; + padding-right: 0.75rem; +} + +.input-group-append .btn:hover, .input-group-prepend .btn:hover { + -webkit-box-shadow: none; + box-shadow: none; +} + +@media (max-width: 575.98px) { + .input-group > .input-group-append > .btn, .input-group > .input-group-prepend > .btn { + padding: 0 0.75rem; + } +} +.bg-primary, .badge-primary { + background-color: #0366d6 !important; +} + +.bg-secondary { + background-color: #6c757d !important; +} + +.text-primary, .btn-light, .btn-outline-light:hover, .btn-link, .btn-outline-light:not(:disabled):not(.disabled).active, .btn-outline-light:not(:disabled):not(.disabled):active { + color: #0366d6 !important; +} + +.btn-link:hover { + color: #0355b3 !important; +} + +.text-secondary { + color: #6c757d !important; +} + +.text-light { + color: #dee3e4 !important; +} + +.text-body { + color: #4c4d4d !important; +} + +a.bg-primary:focus, a.bg-primary:hover, button.bg-primary:focus, button.bg-primary:hover { + background-color: #0355b3 !important; +} + +.border-primary { + border-color: #0366d6 !important; +} + +.border-secondary { + border-color: #6c757d !important; +} + +.btn-primary { + background-color: #0366d6; + border-color: #0366d6; +} +.btn-primary:hover { + background-color: #0355b3; + border-color: #0355b3; +} + +.btn-primary:not(:disabled):not(.disabled).active, .btn-primary:not(:disabled):not(.disabled):active { + background-color: #0355b3; + border-color: #0355b3; +} + +.btn-primary.focus, .btn-primary:focus { + background-color: #0355b3; + border-color: #0355b3; +} + +.btn-primary:not(:disabled):not(.disabled).active:focus, .btn-primary:not(:disabled):not(.disabled):active:focus, .show > .btn-primary.dropdown-toggle:focus { + -webkit-box-shadow: none; + box-shadow: none; +} + +.btn-secondary { + background-color: #6c757d; + border-color: #6c757d; +} + +.btn-outline-primary, .btn-outline-primary:not(:disabled):not(.disabled).active, .btn-outline-primary:not(:disabled):not(.disabled):active { + color: #0366d6; + border-color: #0366d6; +} +.btn-outline-primary:hover, .btn-outline-primary:not(:disabled):not(.disabled).active:hover, .btn-outline-primary:not(:disabled):not(.disabled):active:hover { + background-color: #0366d6; + border-color: #0366d6; + color: #fff; +} + +.btn-outline-secondary { + color: #6c757d; + border-color: #6c757d; +} +.btn-outline-secondary:hover { + background-color: #6c757d; + border-color: #6c757d; + color: #fff; +} + +.progress-bar, +.nav-pills .nav-link.active, .nav-pills .show > .nav-link, .dropdown-item.active, .dropdown-item:active { + background-color: #0366d6; +} + +.page-item.active .page-link, +.custom-radio .custom-control-input:checked ~ .custom-control-label:before, +.custom-control-input:checked ~ .custom-control-label::before, +.custom-checkbox .custom-control-input:checked ~ .custom-control-label:before, +.custom-control-input:checked ~ .custom-control-label:before { + background-color: #0366d6; + border-color: #0366d6; +} + +.list-group-item.active { + background-color: #0366d6; + border-color: #0366d6; +} + +.page-link { + color: #0366d6; +} +.page-link:hover { + color: #0355b3; +} + +/* Pagination */ +.page-link { + border: none; + border-radius: 0.25rem; + margin: 0 0.22rem; + font-size: 16px; + font-size: 1rem; +} +.page-link:hover { + background-color: #e9eff0; +} + +/* Vertical Multilple input group */ +.vertical-input-group .input-group:first-child { + padding-bottom: 0; +} +.vertical-input-group .input-group:first-child * { + border-bottom-left-radius: 0; + border-bottom-right-radius: 0; +} +.vertical-input-group .input-group:last-child { + padding-top: 0; +} +.vertical-input-group .input-group:last-child * { + border-top-left-radius: 0; + border-top-right-radius: 0; +} +.vertical-input-group .input-group:not(:last-child):not(:first-child) { + padding-top: 0; + padding-bottom: 0; +} +.vertical-input-group .input-group:not(:last-child):not(:first-child) * { + border-radius: 0; +} +.vertical-input-group .input-group:not(:first-child) * { + border-top: 0; +} + +/* styles-switcher */ +#styles-switcher { + background: #fff; + width: 202px; + position: fixed; + top: 35%; + z-index: 99; + padding: 20px; + left: -202px; +} +#styles-switcher ul { + padding: 0; +} +#styles-switcher ul li { + list-style-type: none; + width: 25px; + height: 25px; + margin: 4px 2px; + border-radius: 50%; + display: inline-block; + cursor: pointer; + transition: all .2s ease-in-out; +} +#styles-switcher ul li.blue { + background: #007bff; +} +#styles-switcher ul li.brown { + background: #795548; +} +#styles-switcher ul li.purple { + background: #6f42c1; +} +#styles-switcher ul li.indigo { + background: #6610f2; +} +#styles-switcher ul li.red { + background: #dc3545; +} +#styles-switcher ul li.orange { + background: #fd7e14; +} +#styles-switcher ul li.yellow { + background: #ffc107; +} +#styles-switcher ul li.green { + background: #28a745; +} +#styles-switcher ul li.teal { + background: #20c997; +} +#styles-switcher ul li.cyan { + background: #17a2b8; +} +#styles-switcher ul li.active { + transform: scale(0.7); + cursor: default; +} +#styles-switcher .switcher-toggle { + position: absolute; + background: #333; + color: #fff; + font-size: 1.25rem; + border-radius: 0px 4px 4px 0; + right: -40px; + top: 0; + width: 40px; + height: 40px; + padding: 0; +} +#styles-switcher #reset-color { + background: #e83e8c; +} + +input:-internal-autofill-selected { + background-color: transparent; +} + +#styles-switcher.right { + left: auto; + right: -202px; +} + +#styles-switcher.right .switcher-toggle { + right: auto; + left: -40px; + border-radius: 4px 0px 0px 4px; +} + +.tab-wrap{ + border-top: 1px solid #eee; + border-bottom: 1px solid #eee; + padding: 0 10px; + margin-bottom: 40px; +} diff --git a/docs/assets/images/BinanceInstall.png b/docs/assets/images/BinanceInstall.png new file mode 100644 index 0000000..15e99d0 Binary files /dev/null and b/docs/assets/images/BinanceInstall.png differ diff --git a/docs/assets/images/BitfinexInstall.png b/docs/assets/images/BitfinexInstall.png new file mode 100644 index 0000000..6dffa0f Binary files /dev/null and b/docs/assets/images/BitfinexInstall.png differ diff --git a/docs/assets/images/BitgetInstall.png b/docs/assets/images/BitgetInstall.png new file mode 100644 index 0000000..b8515a5 Binary files /dev/null and b/docs/assets/images/BitgetInstall.png differ diff --git a/docs/assets/images/BybitInstall.png b/docs/assets/images/BybitInstall.png new file mode 100644 index 0000000..eca82e9 Binary files /dev/null and b/docs/assets/images/BybitInstall.png differ diff --git a/docs/assets/images/CoinExInstall.png b/docs/assets/images/CoinExInstall.png new file mode 100644 index 0000000..d837197 Binary files /dev/null and b/docs/assets/images/CoinExInstall.png differ diff --git a/docs/assets/images/CoinGeckoInstall.png b/docs/assets/images/CoinGeckoInstall.png new file mode 100644 index 0000000..3a3e61c Binary files /dev/null and b/docs/assets/images/CoinGeckoInstall.png differ diff --git a/docs/assets/images/HuobiInstall.png b/docs/assets/images/HuobiInstall.png new file mode 100644 index 0000000..bbc2a2a Binary files /dev/null and b/docs/assets/images/HuobiInstall.png differ diff --git a/docs/assets/images/KrakenInstall.png b/docs/assets/images/KrakenInstall.png new file mode 100644 index 0000000..a5ea718 Binary files /dev/null and b/docs/assets/images/KrakenInstall.png differ diff --git a/docs/assets/images/KucoinInstall.png b/docs/assets/images/KucoinInstall.png new file mode 100644 index 0000000..e53282e Binary files /dev/null and b/docs/assets/images/KucoinInstall.png differ diff --git a/docs/assets/images/MexcInstall.png b/docs/assets/images/MexcInstall.png new file mode 100644 index 0000000..771d566 Binary files /dev/null and b/docs/assets/images/MexcInstall.png differ diff --git a/docs/assets/images/OKXInstall.png b/docs/assets/images/OKXInstall.png new file mode 100644 index 0000000..e1e9671 Binary files /dev/null and b/docs/assets/images/OKXInstall.png differ diff --git a/docs/assets/images/logo.png b/docs/assets/images/logo.png new file mode 100644 index 0000000..b22379e Binary files /dev/null and b/docs/assets/images/logo.png differ diff --git a/docs/assets/js/theme.js b/docs/assets/js/theme.js new file mode 100644 index 0000000..8fb56af --- /dev/null +++ b/docs/assets/js/theme.js @@ -0,0 +1,162 @@ +/* +================================================================ +* Template: iDocs - One Page Documentation HTML Template +* Written by: Harnish Design - (http://www.harnishdesign.net) +* Description: Main Custom Script File +================================================================ +*/ + + +(function ($) { + "use strict"; + +// Preloader +$(window).on('load', function () { + $('.lds-ellipsis').fadeOut(); // will first fade out the loading animation + $('.preloader').delay(333).fadeOut('slow'); // will fade out the white DIV that covers the website. + $('body').delay(333); +}); + +/*------------------------------- + Primary Menu +--------------------------------- */ + +// Dropdown show on hover +$('.primary-menu ul.navbar-nav li.dropdown, .login-signup ul.navbar-nav li.dropdown').on("mouseover", function() { + if ($(window).width() > 991) { + $(this).find('> .dropdown-menu').stop().slideDown('fast'); + $(this).bind('mouseleave', function() { + $(this).find('> .dropdown-menu').stop().css('display', 'none'); + }); + } +}); + +// When dropdown going off to the out of the screen. +$('.primary-menu ul.navbar-nav .dropdown-menu').each(function() { + var menu = $('#header .container-fluid').offset(); + var dropdown = $(this).parent().offset(); + + var i = (dropdown.left + $(this).outerWidth()) - (menu.left + $('#header .container-fluid').outerWidth()); + + if (i > 0) { + $(this).css('margin-left', '-' + (i + 5) + 'px'); + } + }); +$(function () { + $(".dropdown li").on('mouseenter mouseleave', function (e) { + if ($(window).width() > 991) { + var elm = $('.dropdown-menu', this); + var off = elm.offset(); + var l = off.left; + var w = elm.width(); + var docW = $(window).width(); + var isEntirelyVisible = (l + w + 30 <= docW); + if (!isEntirelyVisible) { + $(elm).addClass('dropdown-menu-right'); + } else { + $(elm).removeClass('dropdown-menu-right'); + } + } + }); +}); + +// DropDown Arrow +$('.primary-menu ul.navbar-nav').find('a.dropdown-toggle').append($('').addClass('arrow')); + + +// Mobile Collapse Nav +$('.primary-menu .navbar-nav .dropdown-toggle[href="#"], .primary-menu .dropdown-toggle[href!="#"] .arrow').on('click', function(e) { + if ($(window).width() < 991) { + e.preventDefault(); + var $parentli = $(this).closest('li'); + $parentli.siblings('li').find('.dropdown-menu:visible').slideUp(); + $parentli.find('> .dropdown-menu').stop().slideToggle(); + $parentli.siblings('li').find('a .arrow.show').toggleClass('show'); + $parentli.find('> a .arrow').toggleClass('show'); + } +}); + + +// Mobile Menu +$('.navbar-toggler').on('click', function() { + $(this).toggleClass('show'); +}); + + +/*------------------------ + Side Navigation +-------------------------- */ + +$('#sidebarCollapse').on('click', function () { + $('#sidebarCollapse span:nth-child(3)').toggleClass('w-50'); + $('.idocs-navigation').toggleClass('active'); +}); + + +/*------------------------ + Sections Scroll +-------------------------- */ + +$('.smooth-scroll,.idocs-navigation a').on('click', function() { + event.preventDefault(); + var sectionTo = $(this).attr('href'); + $('html, body').stop().animate({ + scrollTop: $(sectionTo).offset().top - 120}, 1000, 'easeInOutExpo'); +}); + +/*----------------------------- + Magnific Popup +------------------------------- */ + +// Image on Modal +$('.popup-img').each(function() { +$(this).magnificPopup({ + type: "image", + tLoading: '
', + closeOnContentClick: !0, + mainClass: "mfp-fade", + +}); +}); + +// YouTube/Viemo Video & Gmaps +$('.popup-youtube, .popup-vimeo, .popup-gmaps').each(function() { +$(this).magnificPopup({ + type: 'iframe', + mainClass: 'mfp-fade', +}); +}); + + +/*------------------------ + Highlight Js +-------------------------- */ + +hljs.initHighlightingOnLoad(); + + +/*------------------------ + tooltips +-------------------------- */ +$('[data-toggle=\'tooltip\']').tooltip({container: 'body'}); + + +/*------------------------ + Scroll to top +-------------------------- */ +$(function () { + $(window).on('scroll', function(){ + if ($(this).scrollTop() > 400) { + $('#back-to-top').fadeIn(); + } else { + $('#back-to-top').fadeOut(); + } + }); + }); +$('#back-to-top').on("click", function() { + $('html, body').animate({scrollTop:0}, 'slow'); + return false; +}); + + +})(jQuery) \ No newline at end of file diff --git a/docs/assets/sass/_elements.scss b/docs/assets/sass/_elements.scss new file mode 100644 index 0000000..397f710 --- /dev/null +++ b/docs/assets/sass/_elements.scss @@ -0,0 +1,537 @@ +/* =================================== */ +/* 5. Elements +/* =================================== */ + +/*=== 5.1 List Style ===*/ + +.list-style-1 > li { + position: relative; + list-style-type: none; + line-height: 24px; + &:after { + content: " "; + position: absolute; + top: 12px; + left: -15px; + border-color: #000; + border-top: 1px solid; + border-right: 1px solid; + width: 6px; + height: 6px; + -webkit-transform: translate(-50%, -50%) rotate(45deg); + transform: translate(-50%, -50%) rotate(45deg); + } +} + +.list-style-2{padding:0;} + +.list-style-2 > li { + list-style-type: none; + border-bottom: 1px solid #eaeaea; + padding-top: 12px; + padding-bottom: 12px; +} +.list-style-2.list-style-light > li { + border-bottom: 1px solid rgba(250,250,250,0.12); +} + +/*=== 5.2 Changelog ===*/ + +.changelog { + list-style: none; + padding: 0; + .badge { + width: 90px; + margin-right: 10px; + border-radius: .20rem; + text-transform: uppercase; + } + li { + line-height: 1.8; + } +} + + +/*=== 5.3 Accordion & Toggle ===*/ +.accordion { + .card { + border: none; + margin-bottom: 16px; + margin-bottom: 1rem; + background-color: transparent; + } + .card-header { + padding: 0; + border: none; + background: none; + a { + font-size: 16px; + font-weight:normal; + padding: 1rem 1.25rem 1rem 2.25rem; + display: block; + border-radius: 4px; + position: relative; + &:hover{ + text-decoration:none; + } + &:hover.collapsed { + color: $primary-color!important; + } + } + } + &:not(.accordion-alternate) .card-header a { + background-color: $primary-color; + color: #fff; + &.collapsed { + background-color: #f1f2f4; + color: #4c4d4d; + } + + } + .card-header a { + &:before { + position: absolute; + content: " "; + left: 20px; + top: calc(50% + 2px); + width: 9px; + height: 9px; + border-color: #CCC; + border-top: 2px solid; + border-right: 2px solid; + -webkit-transform: translate(-50%, -50%) rotate(-45deg); + transform: translate(-50%, -50%) rotate(-45deg); + @include transition(all 0.2s ease); + -webkit-backface-visibility: hidden; + backface-visibility: hidden; + } + &.collapsed:before { + top: calc(50% - 2px); + -webkit-transform: translate(-50%, -50%) rotate(135deg); + transform: translate(-50%, -50%) rotate(135deg); + } + } + .card-body { + line-height: 26px; + } + &.arrow-right .card-header a{ + padding-left:1.25rem; + &:before { + right: 15px; + left: auto; + } + } + &.accordion-alternate { + .card { + margin: 0; + } + .card-header a { + padding-left: 1.40rem; + border-top: 1px solid #e4e9ec; + border-radius: 0px; + } + .card:first-of-type .card-header a { + border-top: 0px; + } + .card-header a { + &:before { + left: 6px; + } + &.collapsed { + color: #4c4d4d; + } + } + .card-body { + padding: 0rem 0 1rem 1.25rem; + } + &.arrow-right .card-header a{ + padding-left:0; + &:before { + right: 0px; + left: auto; + } + } + + } + &.toggle .card-header a { + &:before { + content: "-"; + border: none; + font-size: 20px; + height: auto; + top: calc(50% + 2px); + width: auto; + -webkit-transform: translate(-50%, -50%) rotate(180deg); + transform: translate(-50%, -50%) rotate(180deg); + } + &.collapsed:before { + content: "+"; + top: calc(50% - 1px); + -webkit-transform: translate(-50%, -50%) rotate(0deg); + transform: translate(-50%, -50%) rotate(0deg); + } + } + &.accordion-alternate.style-2 { + .card-header a { + &:before { + right: 2px; + left: auto; + -webkit-transform: translate(-50%, -50%) rotate(135deg); + transform: translate(-50%, -50%) rotate(135deg); + top: 50%; + } + &.collapsed:before { + -webkit-transform: translate(-50%, -50%) rotate(45deg); + transform: translate(-50%, -50%) rotate(45deg); + } + padding-left: 0px; + } + .card-body { + padding-left: 0px; + } + } + &.accordion-alternate.popularRoutes { + .card-header { + .nav { + margin-top: 3px; + a { + font-size: 14px; + } + } + a { + padding: 0px 8px 0px 0px; + border: none; + font-size: inherit; + &:before { + content: none; + } + } + h5 { + cursor: pointer; + &:before { + position: absolute; + content: " "; + right: 0px; + top: 24px; + width: 10px; + height: 10px; + opacity: 0.6; + border-top: 2px solid; + border-right: 2px solid; + -webkit-transform: translate(-50%, -50%) rotate(-45deg); + transform: translate(-50%, -50%) rotate(-45deg); + -webkit-transition: all 0.2s ease; + transition: all 0.2s ease; + -webkit-backface-visibility: hidden; + backface-visibility: hidden; + } + &.collapsed:before { + top: 24px; + -webkit-transform: translate(-50%, -50%) rotate(135deg); + transform: translate(-50%, -50%) rotate(135deg); + } + } + } + .card-body { + padding: 0; + } + .card { + border-bottom: 2px solid #e4e9ec; + padding: 15px 0px; + } + .routes-list { + margin: 1rem 0px 0px 0px; + padding: 0px; + list-style: none; + a { + color: inherit; + display: -ms-flexbox !important; + display: flex !important; + -ms-flex-align: center !important; + align-items: center !important; + &:hover { + color: #0071cc; + text-decoration: underline; + } + } + } + } +} + +/* 5.4 Nav */ + +.nav .nav-item .nav-link{color: #222222;} +.nav.nav-light .nav-item .nav-link{color: #ddd;} +.nav:not(.nav-pills) .nav-item .nav-link.active, .nav:not(.nav-pills) .nav-item .nav-link:hover{color: $primary-color;} + + +.nav-pills .nav-link:not(.active):hover{color: $primary-color;} +.nav-pills .nav-link.active,.nav-pills.nav-light .nav-link.active, .nav-pills .show > .nav-link{color:#fff;} + +.nav.nav-separator .nav-item .nav-link{position:relative;} +.nav.nav-separator .nav-item + .nav-item .nav-link:after{ + height: 14px; + width: 1px; + content: ' '; + background-color: rgba(0,0,0,0.2); + display: block; + position: absolute; + top: 50%; + left: 0; + @include translateY(-7px); +} +.nav.nav-separator.nav-separator-light .nav-item + .nav-item .nav-link:after{ +background-color: rgba(250,250,250,0.2); +} + +.nav.nav-sm .nav-item .nav-link{font-size:14px;} + + +/*=== 5.5 Tabs ===*/ + +.nav-tabs { + border-bottom: 1px solid #d7dee3; + .nav-item .nav-link { + border:0; + background: transparent; + + position: relative; + border-radius: 0; + padding:0.6rem 1rem; + color: #7b8084; + white-space: nowrap !important; + &.active { + &:after { + height: 2px; + width: 100%; + content: ' '; + background-color: $primary-color; + display: block; + position: absolute; + bottom: -3px; + left: 0; + @include translateY(-3px); + } + color: #0c2f55; + } + &:not(.active):hover { + color: $primary-color; + } + } + &.flex-column { + border-right: 1px solid #d7dee3; + border-bottom: 0px; + padding: 1.5rem 0; + .nav-item { + .nav-link { + border: 1px solid #d7dee3; + border-right: 0px; + background-color: #f6f7f8; + font-size: 14px; + padding: 0.75rem 1rem; + color: #535b61; + } + &:first-of-type .nav-link { + border-top-left-radius: 4px; + } + &:last-of-type .nav-link { + border-bottom-left-radius: 4px; + } + .nav-link.active { + &:after { + height: 100%; + width: 2px; + background: #fff; + right: -1px; + left: auto; + } + background-color: transparent; + color: $primary-color; + } + } + } +} + +.nav-tabs:not(.flex-column) { + .nav-item { + margin-bottom: 0px; + } + flex-wrap: nowrap; + overflow: hidden; + overflow-x: auto; + -ms-overflow-style: -ms-autohiding-scrollbar; + -webkit-overflow-scrolling: touch; +} + + + +@include media-breakpoint-down(xs) { + .nav-tabs .nav-item .nav-link { + padding-left: 0px; + padding-right: 0px; + margin-right: 10px; + font-size: 0.875rem; + } +} + + +/*=== 5.6 Popup Img ===*/ +.popup-img img{@include transition(all 0.2s ease-in-out);} +.popup-img:hover img{ + opacity:0.8; + cursor: -webkit-zoom-in; + cursor: -moz-zoom-in; + cursor: zoom-in; +} + + +/*=== 5.7 Featured Box ===*/ +.featured-box { + box-sizing: border-box; + position: relative; + h3, h4 { + font-size: 1.25rem; + font-size: 20px; + margin-bottom: 10px; + font-weight: 500; + } + &:not(.style-5) .featured-box-icon { + display: inline-block; + font-size: 48px; + min-width: 55px; + min-height: 55px; + padding: 0; + margin-top: 0; + margin-bottom: 0.8rem; + color: #4c4d4d; + border-radius: 0; + } + &.style-1, &.style-2, &.style-3 { + padding-left: 50px; + padding-top: 8px; + } + &.style-1 .featured-box-icon, &.style-2 .featured-box-icon, &.style-3 .featured-box-icon { + position: absolute; + top: 0; + left: 0; + margin-bottom: 0; + font-size: 30px; + -ms-flex-pack: center !important; + justify-content: center !important; + text-align: center; + } + &.style-2 p { + margin-left: -50px; + } + &.style-3 { + padding-left: 90px; + padding-top: 0px; + .featured-box-icon { + width: 70px; + height: 70px; + -ms-flex-negative: 0; + flex-shrink: 0; + display: -webkit-box; + display: -ms-flexbox; + display: flex; + -webkit-box-align: center; + -ms-flex-align: center; + align-items: center; + } + } + &.style-4 { + text-align: center; + .featured-box-icon { + margin: 0 auto 24px; + margin: 0 auto 1.5rem; + width: 120px; + height: 120px; + text-align: center; + -ms-flex-negative: 0; + flex-shrink: 0; + display: -webkit-box; + display: -ms-flexbox; + display: flex; + -webkit-box-align: center; + -ms-flex-align: center; + align-items: center; + -ms-flex-pack: center; + justify-content: center; + @include box-shadow(0px 0px 50px rgba(0, 0, 0, 0.03)); + } + } + + &.style-5 { + text-align: center; + background: #fff; + border: 1px solid #f0f2f3; + @include box-shadow(0px 2px 5px rgba(0, 0, 0, 0.05)); + @include transition(all 0.3s ease-in-out); + &:hover { + border: 1px solid #ebeded; + @include box-shadow(0px 5px 1.5rem rgba(0, 0, 0, 0.15)); + } + h3 { + background: #f1f5f6; + font-size: 16px; + padding: 8px 0; + margin-bottom: 0px; + } + .featured-box-icon { + font-size: 50px; + margin: 44px 0px; + } +} +} + + +@mixin featured-box-reverse { + text-align:right; + &.style-1, &.style-2{ + padding-right:50px; + padding-left:0px; + .featured-box-icon{ + left:auto; + right:0px; + } + } + &.style-2 p{ + margin-right: -50px; + margin-left:0; + } + &.style-3{ + padding-left:0; + padding-right:90px; + .featured-box-icon{ + left:auto; + right:0px; + } + } +} + +.featured-box.featured-box-reverse{ + @include featured-box-reverse; +} + +@include media-breakpoint-up(xs) { + .featured-box.featured-box-reverse-sm{ + @include featured-box-reverse; + } +} + +@include media-breakpoint-up(sm) { + .featured-box.featured-box-reverse-md{ + @include featured-box-reverse; + } +} + +@include media-breakpoint-up(md) { + .featured-box.featured-box-reverse-lg{ + @include featured-box-reverse; + } +} +@include media-breakpoint-up(lg) { + .featured-box.featured-box-reverse-xl{ + @include featured-box-reverse; + } +} \ No newline at end of file diff --git a/docs/assets/sass/_extras.scss b/docs/assets/sass/_extras.scss new file mode 100644 index 0000000..c07f209 --- /dev/null +++ b/docs/assets/sass/_extras.scss @@ -0,0 +1,448 @@ +/* =================================== */ +/* Extras +/* =================================== */ + +/* Bootstrap Specific */ + +.form-control, .custom-select { + border-color: #dae1e3; + font-size: 16px; + color: #656565; +} + +.form-control:not(.form-control-sm) { + padding: .810rem .96rem; + height:inherit; +} + +.form-control-sm{font-size:14px;} + +.icon-inside { + position: absolute; + right: 15px; + top: calc(50% - 11px); + pointer-events: none; + font-size: 18px; + font-size: 1.125rem; + color: #c4c3c3; + z-index:3; +} +.form-control-sm + .icon-inside { + font-size: 0.875rem !important; + font-size: 14px; + top: calc(50% - 13px); +} + +select.form-control:not([size]):not([multiple]):not(.form-control-sm) { + height: auto; + padding-top: .700rem; + padding-bottom: .700rem; +} +.custom-select:not(.custom-select-sm){ + height:calc(3.05rem + 2px); + padding-top: .700rem; + padding-bottom: .700rem;} +.col-form-label-sm{font-size:13px;} +.custom-select-sm{padding-left:5px!important; font-size:14px;} +.custom-select:not(.custom-select-sm).border-0{height:3.00rem;} + +.form-control:focus, .custom-select:focus{ + @include box-shadow(0 0 5px rgba(128, 189, 255, 0.5)); +} +.form-control:focus[readonly]{box-shadow:none;} + +.input-group-text { + border-color: #dae1e3; + background-color:#f1f5f6; + color: #656565; +} + +.form-control { + &::-webkit-input-placeholder { + color: #b1b4b6; + } + &:-moz-placeholder { + /* FF 4-18 */ + color: #b1b4b6; + } + &::-moz-placeholder { + /* FF 19+ */ + color: #b1b4b6; + } + &:-ms-input-placeholder, &::-ms-input-placeholder { + /* IE 10+ */ + color: #b1b4b6; + } +} + +/* Form Dark */ +.form-dark { + .form-control, .custom-select { + border-color: #232a31; + background:#232a31; + color: #fff; + } + .form-control:focus{border-color: #80bdff!important;} + .form-control { + &::-webkit-input-placeholder { + color: #777b7f; + } + &:-moz-placeholder { + /* FF 4-18 */ + color: #777b7f; + } + &::-moz-placeholder { + /* FF 19+ */ + color: #777b7f; + } + &:-ms-input-placeholder, &::-ms-input-placeholder { + /* IE 10+ */ + color: #777b7f; + } + } + .custom-select { + color: #777b7f; + background: url("data:image/svg+xml;charset=utf8,%3Csvg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 4 5'%3E%3Cpath fill='rgba(250,250,250,0.3)' d='M2 0L0 2h4zm0 5L0 3h4z'/%3E%3C/svg%3E") no-repeat right 0.75rem center; + background-size: 13px 15px; + border-color: #232a31; + background-color:#232a31; + } + .icon-inside { + color: #777b7f; + } +} + +/* Input with only bottom border */ +.form-border { + .form-control { + background-color: transparent; + border: none; + border-bottom: 2px solid rgba(0, 0, 0, 0.12); + border-radius: 0px; + padding-left: 0px!important; + color: rgba(0, 0, 0, 1); + &::-webkit-input-placeholder { + color: rgba(0, 0, 0, 0.4); + } + &:-moz-placeholder { + /* FF 4-18 */ + color: rgba(0, 0, 0, 0.4); + } + &::-moz-placeholder { + /* FF 19+ */ + color: rgba(0, 0, 0, 0.4); + } + &:-ms-input-placeholder, &::-ms-input-placeholder { + /* IE 10+ */ + color: rgba(0, 0, 0, 0.4); + } + } + .custom-select { + background-color: transparent; + border: none; + border-bottom: 2px solid rgba(0, 0, 0, 0.12); + border-radius: 0px; + padding-left: 0px; + color: rgba(0, 0, 0, 0.4); + background: url("data:image/svg+xml;charset=utf8,%3Csvg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 4 5'%3E%3Cpath fill='rgba(0,0,0,0.3)' d='M2 0L0 2h4zm0 5L0 3h4z'/%3E%3C/svg%3E") no-repeat right 0.75rem center; + background-size: 13px 15px; + } + .form-control:focus, .custom-select:focus { + box-shadow: none; + -webkit-box-shadow: none; + border-bottom: 2px solid rgba(0, 0, 0, 0.7); + } + .form-control:not(output):-moz-ui-invalid, .custom-select:not(output):-moz-ui-invalid { + &:not(:focus), &:-moz-focusring:not(:focus) { + border-bottom: 2px solid #b00708; + box-shadow: none; + -webkit-box-shadow: none; + } + } + .icon-inside { + color: rgba(0, 0, 0, 0.25); + } + select option { + color: #666; + } +} + +.form-border-light { + .form-control { + border-bottom: 2px solid rgba(250, 250, 250, 0.3); + color: rgba(250, 250, 250, 1); + &::-webkit-input-placeholder { + color: rgba(250, 250, 250, 0.7); + } + &:-moz-placeholder { + /* FF 4-18 */ + color: rgba(250, 250, 250, 0.7); + } + &::-moz-placeholder { + /* FF 19+ */ + color: rgba(250, 250, 250, 0.7); + } + &:-ms-input-placeholder, &::-ms-input-placeholder { + /* IE 10+ */ + color: rgba(250, 250, 250, 0.7); + } + } + .custom-select { + border-bottom: 2px solid rgba(250, 250, 250, 0.3); + color: rgba(250, 250, 250, 1); + background: url("data:image/svg+xml;charset=utf8,%3Csvg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 4 5'%3E%3Cpath fill='rgba(250,250,250,0.6)' d='M2 0L0 2h4zm0 5L0 3h4z'/%3E%3C/svg%3E") no-repeat right 0.75rem center; + background-size: 13px 15px; + } + .form-control:focus, .custom-select:focus { + border-bottom: 2px solid rgba(250, 250, 250, 0.8); + } + .icon-inside { + color: #999; + } + select option { + color: #333; + } +} + +.input-group-append .btn, .input-group-prepend .btn { + @include box-shadow(none); + padding-left: 0.75rem; + padding-right: 0.75rem; +} + +.input-group-append .btn:hover, .input-group-prepend .btn:hover { + @include box-shadow(none); +} + +@include media-breakpoint-down(xs) { + .input-group > { + .input-group-append > .btn, .input-group-prepend > .btn { + padding: 0 0.75rem; + } +} +} + +.bg-primary, .badge-primary { + background-color: $primary-color !important; +} +.bg-secondary { + background-color: $secondary-color !important; +} + +.text-primary, .btn-light, .btn-outline-light:hover, .btn-link, .btn-outline-light:not(:disabled):not(.disabled).active, .btn-outline-light:not(:disabled):not(.disabled):active { + color: $primary-color !important; +} + +.btn-link:hover { + color: $primary-color-hover !important; +} +.text-secondary{ + color: $secondary-color !important; +} + +.text-light{ + color:#dee3e4!important; +} +.text-body{ + color: $text-color !important; +} +a.bg-primary:focus, a.bg-primary:hover, button.bg-primary:focus, button.bg-primary:hover{background-color: $primary-color-hover!important;} + +.border-primary { + border-color: $primary-color !important; +} +.border-secondary { + border-color: $secondary-color !important; +} + +.btn-primary{ + background-color: $primary-color; + border-color: $primary-color; + &:hover { + background-color: $primary-color-hover; + border-color: $primary-color-hover; + } +} + +.btn-primary:not(:disabled):not(.disabled).active, .btn-primary:not(:disabled):not(.disabled):active{ + background-color: $primary-color-hover; + border-color: $primary-color-hover; + +} + +.btn-primary.focus, .btn-primary:focus{ + background-color: $primary-color-hover; + border-color: $primary-color-hover; +} + +.btn-primary:not(:disabled):not(.disabled).active:focus, .btn-primary:not(:disabled):not(.disabled):active:focus, .show > .btn-primary.dropdown-toggle:focus{ + @include box-shadow(none); +} + +.btn-secondary { + background-color: $secondary-color; + border-color: $secondary-color; +} + +.btn-outline-primary, .btn-outline-primary:not(:disabled):not(.disabled).active, .btn-outline-primary:not(:disabled):not(.disabled):active{ + color: $primary-color; + border-color: $primary-color; + &:hover { + background-color: $primary-color; + border-color: $primary-color; + color: #fff; + } +} + +.btn-outline-secondary{ + color: $secondary-color; + border-color: $secondary-color; + &:hover { + background-color: $secondary-color; + border-color: $secondary-color; + color: #fff; + } +} + +.progress-bar, +.nav-pills .nav-link.active, .nav-pills .show > .nav-link, .dropdown-item.active, .dropdown-item:active{ + background-color: $primary-color; +} +.page-item.active .page-link, +.custom-radio .custom-control-input:checked ~ .custom-control-label:before, +.custom-control-input:checked ~ .custom-control-label::before, +.custom-checkbox .custom-control-input:checked ~ .custom-control-label:before, +.custom-control-input:checked ~ .custom-control-label:before{ + background-color: $primary-color; + border-color: $primary-color; +} +.list-group-item.active{ + background-color: $primary-color; + border-color: $primary-color; +} +.page-link { + color: $primary-color; + &:hover { + color: $primary-color-hover; + } +} + +/* Pagination */ + +.page-link { + border: none; + border-radius: 0.25rem; + margin: 0 0.22rem; + font-size: 16px; + font-size: 1rem; + &:hover { + background-color: #e9eff0; + } +} + +/* Vertical Multilple input group */ + +.vertical-input-group .input-group { + &:first-child { + padding-bottom: 0; + * { + border-bottom-left-radius: 0; + border-bottom-right-radius: 0; + } + } + &:last-child { + padding-top: 0; + * { + border-top-left-radius: 0; + border-top-right-radius: 0; + } + } + &:not(:last-child):not(:first-child) { + padding-top: 0; + padding-bottom: 0; + * { + border-radius: 0; + } + } + &:not(:first-child) * { + border-top: 0; + } +} + +/* styles-switcher */ +#styles-switcher { + background: #fff; + width: 202px; + position: fixed; + top: 35%; + z-index: 99; + padding: 20px; + left: -202px; + ul { + padding: 0; + li { + list-style-type: none; + width: 25px; + height: 25px; + margin: 4px 2px; + border-radius: 50%; + display: inline-block; + cursor: pointer; + transition: all .2s ease-in-out; + &.blue { + background: #007bff; + } + &.brown { + background: #795548; + } + &.purple { + background: #6f42c1; + } + &.indigo { + background: #6610f2; + } + &.red { + background: #dc3545; + } + &.orange { + background: #fd7e14; + } + &.yellow { + background: #ffc107; + } + &.green { + background: #28a745; + } + &.teal { + background: #20c997; + } + &.cyan { + background: #17a2b8; + } + &.active { + transform: scale(0.7); + cursor:default; + } + } + } + .switcher-toggle { + position: absolute; + background: #333; + color: #fff; + font-size: 1.25rem; + border-radius: 0px 4px 4px 0; + right: -40px; + top: 0; + width: 40px; + height: 40px; + padding: 0; + } + #reset-color{background: #e83e8c;} +} + +input:-internal-autofill-selected { + background-color: transparent; +} + +#styles-switcher.right{left:auto; right: -202px;} +#styles-switcher.right .switcher-toggle{right: auto; left: -40px; border-radius: 4px 0px 0px 4px;} \ No newline at end of file diff --git a/docs/assets/sass/_footer.scss b/docs/assets/sass/_footer.scss new file mode 100644 index 0000000..44ee02c --- /dev/null +++ b/docs/assets/sass/_footer.scss @@ -0,0 +1,188 @@ +/* =================================== */ +/* 6. Footer +/* =================================== */ + +#footer { + background: #fff; + color: #252b33; + margin-left:260px; + padding: 66px 0px; + padding: 4.125rem 0; + .nav { + .nav-item { + display: inline-block; + line-height: 12px; + margin: 0; + .nav-link { + color: #252b33; + -webkit-transition: all 0.2s ease; + transition: all 0.2s ease; + &:focus { + color: $primary-color; + -webkit-transition: all 0.2s ease; + transition: all 0.2s ease; + } + } + &:first-child .nav-link { + padding-left: 0px; + } + &:last-child .nav-link{ + padding-right: 0px; + } + } + .nav-link:hover { + color: $primary-color; + -webkit-transition: all 0.2s ease; + transition: all 0.2s ease; + } + } + .footer-copyright { + border-top: 1px solid #e2e8ea; + padding: 0px 0px; + color: #67727c; + .nav { + .nav-item .nav-link { + color: #67727c; + } + .nav-link:hover { + color: $primary-color; + -webkit-transition: all 0.2s ease; + transition: all 0.2s ease; + } + } + } + .nav.flex-column .nav-item { + padding: 0px; + .nav-link { + margin: 0.7rem 0px; + } + } + &.footer-text-light { + color: rgba(250, 250, 250, 0.8); + .nav .nav-item .nav-link { + color: rgba(250, 250, 250, 0.8); + &:hover { + color: rgba(250, 250, 250, 1); + } + } + .footer-copyright { + border-color: rgba(250, 250, 250, 0.15); + color: rgba(250, 250, 250, 0.5); + } + &:not(.bg-primary) .social-icons-light.social-icons li a { + color: rgba(250, 250, 250, 0.8); + &:hover { + color: rgba(250, 250, 250, 1); + } + } + &.bg-primary { + color: #fff; + .nav .nav-item .nav-link { + color: #fff; + &:hover { + color: rgba(250, 250, 250, 0.7); + } + } + .footer-copyright { + border-color: rgba(250, 250, 250, 0.15); + color: rgba(250, 250, 250, 0.9); + } + :not(.social-icons) a { + color: #fff; + &:hover { + color: rgba(250, 250, 250, 0.7); + } + } + } + } +} + +@include media-breakpoint-down(sm) { +#footer { + margin-left:0px; +} +} + + +/*=== 6.1 Social Icons ===*/ +.social-icons { + margin: 0; + padding: 0; + display: -ms-flexbox; + display: flex; + -ms-flex-wrap: wrap; + flex-wrap: wrap; + list-style: none; + li { + margin: 0px 6px; + padding: 0; + overflow: visible; + a { + display: block; + height: 26px; + line-height: 26px; + width: 26px; + font-size: 18px; + text-align: center; + color: #4d555a; + text-decoration: none; + @include transition(all 0.2s ease); + } + i { + line-height: inherit; + } + } + &.social-icons-sm li{ + margin: 0px 4px; + } + &.social-icons-sm li a { + font-size: 15px; + width:22px; + } + &.social-icons-lg li a { + width: 34px; + height: 34px; + line-height:34px; + font-size: 22px; + } + &.social-icons-light li a { + color: #eee; + } + &.social-icons-muted li a { + color: #aab1b8; + } + li:hover { + a { + color: #999; + } + } +} + + +/*=== 6.2 Back to Top ===*/ +#back-to-top { + display: none; + position: fixed; + z-index: 1030; + bottom: 8px; + right: 10px; + background-color: rgba(0, 0, 0, 0.22); + text-align: center; + color: #fff; + font-size: 14px; + width: 36px; + height: 36px; + line-height: 34px; + border-radius:3px; + @include transition(all 0.3s ease-in-out); + @include box-shadow(0px 5px 15px rgba(0, 0, 0, 0.15)); + &:hover { + background-color: $primary-color; + @include box-shadow(0px 5px 15px rgba(0, 0, 0, 0.25)); + @include transition(all 0.3s ease-in-out); + } +} + +@include media-breakpoint-down(xs) { + #back-to-top {z-index: 1029;} +} \ No newline at end of file diff --git a/docs/assets/sass/_header.scss b/docs/assets/sass/_header.scss new file mode 100644 index 0000000..6b00328 --- /dev/null +++ b/docs/assets/sass/_header.scss @@ -0,0 +1,554 @@ +/* =================================== */ +/* 4. Header +/* =================================== */ + +#header { + @include transition(all .5s ease); + .navbar { + padding: 0px; + min-height:70px; + } + .logo { + -webkit-box-align: center; + -ms-flex-align: center; + align-items: center; + display: -webkit-box; + display: -ms-flexbox; + display: flex; + -ms-flex-item-align: stretch; + align-self: stretch; + } +} + + +/*=== 4.1 Main Navigation ===*/ + +.navbar-light .navbar-nav { + .active > .nav-link { + color: #0c2f55; + } + .nav-link { + &.active, &.show { + color: #0c2f55; + } + } + .show > .nav-link { + color: #0c2f55; + } +} + +.primary-menu { + display: -webkit-box !important; + display: -ms-flexbox !important; + display: flex !important; + height: auto !important; + -webkit-box-ordinal-group: 0; + -ms-flex-item-align: stretch; + align-self: stretch; + background: #fff; + border-bottom:1px solid #efefef; + &.bg-transparent { + position: absolute; + z-index: 999; + top: 0; + left: 0; + width: 100%; + box-shadow: none; + border-bottom: 1px solid rgba(250, 250, 250, 0.3); + } + &.sticky-on{ + position: fixed; + top: 0; + width: 100%; + z-index: 1020; + left: 0; + @include box-shadow(0px 0px 10px rgba(0, 0, 0, 0.05)); + -webkit-animation: slide-down 0.7s; + -moz-animation: slide-down 0.7s; + animation: slide-down 0.7s; + @-webkit-keyframes slide-down { 0% { opacity:0; transform:translateY(-100%);}100% { opacity:1; transform:translateY(0);}} + @-moz-keyframes slide-down { 0% { opacity:0; transform:translateY(-100%);}100% { opacity:1; transform:translateY(0);}} + @keyframes slide-down { 0% { opacity:0; transform:translateY(-100%);}100% { opacity:1; transform:translateY(0);}} + + .none-on-sticky{ + display:none!important; + } + } + + ul.navbar-nav > li { + display: -webkit-box; + display: -ms-flexbox; + display: flex; + height: 100%; + + + li { + margin-left: 2px; + } + a { + display: -webkit-box; + display: -ms-flexbox; + display: flex; + -webkit-box-align: center; + -ms-flex-align: center; + align-items: center; + } + + > a:not(.btn) { + height: 70px; + padding:0px 0.85em; + color: #252b33; + @include transition(all .2s ease); + position: relative; + position:relative; + } + + &:hover > a:not(.btn), & > a.active:not(.btn) { + color: $primary-color; + text-decoration:none; + @include transition(all .2s ease); + } + a.btn{padding: 0.4rem 1.4rem;} + &.dropdown { + .dropdown-menu li { + > a:not(.btn) { + padding: 8px 0px; + background-color: transparent; + text-transform: none; + color: #777; + @include transition(all .2s ease); + } + &:hover > a:not(.btn) { + color: $primary-color; + @include transition(all .2s ease); + } + } + &:hover > a:after { + clear: both; + content: ' '; + display: block; + width: 0; + height: 0; + border-style: solid; + border-color: transparent transparent #fff transparent; + position: absolute; + border-width: 0px 7px 6px 7px; + bottom: 0px; + left: 50%; + margin: 0 0 0 -5px; + z-index: 1022; + } + .dropdown-menu { + @include box-shadow(0px 0px 12px rgba(0, 0, 0, 0.176)); + border: 0px none; + padding: 10px 15px; + min-width: 220px; + margin: 0; + font-size: 14px; + font-size: 0.875rem; + z-index:1021; + } + > .dropdown-toggle .arrow { + display: none; + + } + } + } + .dropdown-menu-right { + left: auto !important; + right: 100% !important; + } + ul.navbar-nav > li { + &.dropdown-mega { + position: static; + > .dropdown-menu { + width: 100%; + padding: 20px 20px; + margin-left: 0px !important; + } + .dropdown-mega-content > .row > div { + padding: 5px 5px 5px 20px; + border-right: 1px solid #eee; + &:last-child { + border-right: 0; + } + } + .sub-title { + display: block; + font-size: 16px; + margin-top: 1rem; + padding-bottom: 5px; + } + .dropdown-mega-submenu { + list-style-type: none; + padding-left: 0px; + } + } + a.btn{font-size:14px; padding: 0.65rem 2rem; text-transform:uppercase;} + &.dropdown { + .dropdown-menu { + .dropdown-menu { + left: 100%; + margin-top: -40px; + } + .dropdown-toggle:after { + border-top: .4em solid transparent; + border-right: 0; + border-bottom: 0.4em solid transparent; + border-left: 0.4em solid; + } + } + .dropdown-toggle .arrow { + position: absolute; + min-width: 30px; + height: 100%; + right: 0px; + top: 0; + @include transition(all .2s ease); + &:after { + content: " "; + position: absolute; + top: 50%; + left: 50%; + border-color: #000; + border-top: 1px solid; + border-right: 1px solid; + width: 6px; + height: 6px; + -webkit-transform: translate(-50%, -50%) rotate(45deg); + transform: translate(-50%, -50%) rotate(45deg); + } + } + } + } + .dropdown-toggle:after { + content: none; + } + + &.navbar-line-under-text ul.navbar-nav > li { + > a:not(.btn):after { + position: absolute; + content: ""; + height: 2px; + width: 0; + left: 50%; + right: 0; + bottom: 14px; + background-color: transparent; + color:#fff; + border-bottom: 2px solid $primary-color; + @include transition(all .3s ease-in-out); + transform: translate(-50%,0) translateZ(0); + -webkit-transform: translate(-50%,0) translateZ(0); + } + & > a:hover:not(.logo):after, & > a.active:after{ + width:calc(100% - 0.99em); + } + } + +} + +/*== Color Options ==*/ + +.primary-menu.navbar-text-light .navbar-toggler span {background:#fff;} + +.primary-menu.navbar-text-light .navbar-nav > li{ + > a:not(.btn) { + color: #fff; + } + &:hover > a:not(.btn), & > a.active:not(.btn) { + color: rgba(250, 250, 250, 0.75); + } +} + +.primary-menu.navbar-text-light.navbar-line-under-text .navbar-nav > li{ + & > a:not(.logo):after, & > a.active:after{ + border-color:rgba(250, 250, 250, 0.60); + } +} + +.primary-menu { + &.navbar-dropdown-dark ul.navbar-nav > li { + &.dropdown { + .dropdown-menu { + background-color: #252A2C; + color: #fff; + .dropdown-menu { + background-color: #272c2e; + } + } + &:hover > a:after { + border-color: transparent transparent #252A2C transparent; + } + .dropdown-menu li { + > a:not(.btn) { + color: rgba(250, 250, 250, 0.8); + } + &:hover > a:not(.btn) { + color: rgba(250, 250, 250, 1); + font-weight:600; + } + } + } + &.dropdown-mega .dropdown-mega-content > .row > div { + border-color: #3a3a3a; + } + } + &.navbar-dropdown-primary ul.navbar-nav > li { + &.dropdown { + .dropdown-menu { + background-color: $primary-color; + color: #fff; + .dropdown-menu { + background-color: $primary-color; + } + } + &:hover > a:after { + border-color: transparent transparent $primary-color transparent; + } + .dropdown-menu li { + > a:not(.btn) { + color: rgba(250, 250, 250, 0.95); + } + &:hover > a:not(.btn) { + color: rgba(250, 250, 250, 1); + font-weight:600; + } + } + } + &.dropdown-mega .dropdown-mega-content > .row > div { + border-color: rgba(250, 250, 250, 0.2); + } + } +} + + +/* Hamburger Menu Button */ +.navbar-toggler { + width: 25px; + height: 30px; + padding: 10px; + margin: 18px 15px; + position: relative; + border:none; + @include rotate(0deg); + @include transition(.5s ease-in-out); + cursor: pointer; + display: block; + span { + display: block; + position: absolute; + height: 2px; + width: 100%; + background: #3c3636; + border-radius: 2px; + opacity: 1; + left: 0; + @include rotate(0deg); + @include transition(.25s ease-in-out); + &:nth-child(1) { + top: 7px; + -webkit-transform-origin: left center; + -moz-transform-origin: left center; + -o-transform-origin: left center; + transform-origin: left center; + } + &:nth-child(2) { + top: 14px; + -webkit-transform-origin: left center; + -moz-transform-origin: left center; + -o-transform-origin: left center; + transform-origin: left center; + } + &:nth-child(3) { + top: 21px; + -webkit-transform-origin: left center; + -moz-transform-origin: left center; + -o-transform-origin: left center; + transform-origin: left center; + + } + } + &.show span { + &:nth-child(1) { + top: 4px; + left: 3px; + @include rotate(45deg); + } + &:nth-child(2) { + width: 0%; + opacity: 0; + } + &:nth-child(3) { + top: 22px; + left: 3px; + @include rotate(-45deg); + } + } + +} + +.navbar-accordion{position:initial;} + + +// For Responsive Navbar +@mixin navbar-responsive { + +.navbar-collapse { + position: absolute; + top: 99%; + right: 0; + left: 0; + background: #fff; + margin-top: 0px; + z-index: 1000; + @include box-shadow(0px 0px 15px rgba(0, 0, 0, 0.1)); + .navbar-nav { + overflow: hidden; + overflow-y: auto; + max-height: 65vh; + padding: 15px; + } +} +ul.navbar-nav { + li { + display: block; + border-bottom: 1px solid #eee; + margin: 0; + padding: 0; + &:last-child { + border: none; + } + + li { + margin-left: 0px; + } + &.dropdown > .dropdown-toggle > .arrow.show:after { + -webkit-transform: translate(-50%, -50%) rotate(-45deg); + transform: translate(-50%, -50%) rotate(-45deg); + @include transition(all .2s ease); + } + > a:hover:after, > a.active:after { + content: none!important; + width:0px!important; + } + &.dropdown{ + > .dropdown-toggle .arrow { + display: block; + + } + } + } + + > li { + > a:not(.btn) { + height: auto; + padding: 8px 0; + position: relative; + } + &.dropdown { + .dropdown-menu li > a:not(.btn) { + padding: 8px 0; + position: relative; + } + &:hover > a:after { + content: none; + } + .dropdown-toggle .arrow:after { + -webkit-transform: translate(-50%, -50%) rotate(134deg); + transform: translate(-50%, -50%) rotate(134deg); + @include transition(all .2s ease); + } + } + } + > li { + &.dropdown .dropdown-menu { + margin: 0; + @include box-shadow(none); + border: none; + padding: 0px 0px 0px 15px; + .dropdown-menu { + margin: 0; + } + } + &.dropdown-mega { + .dropdown-mega-content > .row > div { + padding: 0px 15px; + } + } + } + +} + +&.navbar-text-light .navbar-collapse{background:rgba(0,0,0,0.95);} + +&.navbar-text-light .navbar-collapse ul.navbar-nav li{ + border-color:rgba(250,250,250,0.15); +} + + +&.navbar-dropdown-dark .navbar-collapse { + background-color: #252A2C; +} + +&.navbar-dropdown-primary .navbar-collapse { + background-color: $primary-color; +} + + &.navbar-dropdown-primary ul.navbar-nav > li.dropdown .dropdown-menu .dropdown-menu { + background-color: $primary-color; + } + &.navbar-dropdown-dark ul.navbar-nav { + li { + border-color: #444; + } + > li { + > a { + color: #a3a2a2; + } + &:hover > a { + color: #fff; + } + } + } + &.navbar-dropdown-primary ul.navbar-nav { + li { + border-color: rgba(250, 250, 250, 0.2); + } + > li { + > a { + color: rgba(250, 250, 250, 0.8); + } + &:hover > a { + color: #fff; + } + } + } + +} + +.navbar-expand-none{ + @include navbar-responsive; +} + + +@include media-breakpoint-down(xs) { + .navbar-expand-sm{ + @include navbar-responsive; + } +} + +@include media-breakpoint-down(sm) { + .navbar-expand-md{ + @include navbar-responsive; + } +} + +@include media-breakpoint-down(md) { + .navbar-expand-lg{ + @include navbar-responsive; + } +} +@include media-breakpoint-down(lg) { + .navbar-expand-xl{ + @include navbar-responsive; + } +} \ No newline at end of file diff --git a/docs/assets/sass/_helpers.scss b/docs/assets/sass/_helpers.scss new file mode 100644 index 0000000..6845d7b --- /dev/null +++ b/docs/assets/sass/_helpers.scss @@ -0,0 +1,301 @@ +/* =================================== */ +/* 2. Helpers Classes +/* =================================== */ + +/* Box Shadow */ +.shadow-md { + @include box-shadow(0px 0px 50px -35px rgba(0, 0, 0, 0.4)!important); +} + +/* Border Radius */ + +.rounded-lg{ + border-radius: 0.6rem !important; +} + +.rounded-top-0{ + border-top-left-radius:0px!important; + border-top-right-radius:0px!important; +} +.rounded-bottom-0{ + border-bottom-left-radius:0px!important; + border-bottom-right-radius:0px!important; +} +.rounded-left-0{ + border-top-left-radius:0px!important; + border-bottom-left-radius:0px!important; +} +.rounded-right-0{border-top-right-radius:0px!important; + border-bottom-right-radius:0px!important; +} + + +/* Border Size */ + +.border-1{ + border-width:1px!important; +} +.border-2{ + border-width:2px!important; +} +.border-3{ + border-width:3px!important; +} +.border-4{ + border-width:4px!important; +} +.border-5{ + border-width:5px!important; +} + +/* Text Size */ +.text-0 { + font-size: 11px !important; + font-size: 0.6875rem !important; +} +.text-1 { + font-size: 12px !important; + font-size: 0.75rem !important; +} +.text-2 { + font-size: 14px !important; + font-size: 0.875rem !important; +} +.text-3 { + font-size: 16px !important; + font-size: 1rem !important; +} +.text-4 { + font-size: 18px !important; + font-size: 1.125rem !important; +} +.text-5 { + font-size: 21px !important; + font-size: 1.3125rem !important; +} +.text-6 { + font-size: 24px !important; + font-size: 1.50rem !important; +} +.text-7 { + font-size: 28px !important; + font-size: 1.75rem !important; +} +.text-8 { + font-size: 32px !important; + font-size: 2rem !important; +} +.text-9 { + font-size: 36px !important; + font-size: 2.25rem !important; +} +.text-10 { + font-size: 40px !important; + font-size: 2.50rem !important; +} +.text-11 { + @include rfs(44, true); +} +.text-12 { + @include rfs(48, true); +} +.text-13 { + @include rfs(52, true); +} +.text-14 { + @include rfs(56, true); +} +.text-15 { + @include rfs(60, true); +} +.text-16 { + @include rfs(64, true); +} +.text-17 { + @include rfs(72, true); +} +.text-18 { + @include rfs(80, true); +} +.text-19 { + @include rfs(84, true); +} +.text-20 { + @include rfs(92, true); +} +.text-21 { + @include rfs(104, true); +} +.text-22 { + @include rfs(112, true); +} +.text-23 { + @include rfs(124, true); +} +.text-24 { + @include rfs(132, true); +} +.text-25 { + @include rfs(144, true); +} + +.text-11, .text-12, .text-13, .text-14, .text-15, .text-16, .text-17, .text-18, .text-19, .text-20, .text-21, .text-22, .text-23, .text-24, .text-25{ + line-height: 1.3; +} + + +/* Line height */ +.line-height-07 { + line-height: 0.7 !important; +} + +.line-height-1 { + line-height: 1 !important; +} + +.line-height-2 { + line-height: 1.2 !important; +} + +.line-height-3 { + line-height: 1.4 !important; +} + +.line-height-4 { + line-height: 1.6 !important; +} + +.line-height-5 { + line-height: 1.8 !important; +} + +/* Font Weight */ +.font-weight-100 { + font-weight: 100 !important; +} + +.font-weight-200 { + font-weight: 200 !important; +} + +.font-weight-300 { + font-weight: 300 !important; +} + +.font-weight-400 { + font-weight: 400 !important; +} +.font-weight-500 { + font-weight: 500 !important; +} + +.font-weight-600 { + font-weight: 600 !important; +} +.font-weight-700 { + font-weight: 700 !important; +} +.font-weight-800 { + font-weight: 800 !important; +} +.font-weight-900 { + font-weight: 900 !important; +} + +/* Opacity */ +.opacity-0 { + opacity: 0; +} + +.opacity-1 { + opacity: 0.1; +} + +.opacity-2 { + opacity: 0.2; +} + +.opacity-3 { + opacity: 0.3; +} + +.opacity-4 { + opacity: 0.4; +} + +.opacity-5 { + opacity: 0.5; +} + +.opacity-6 { + opacity: 0.6; +} + +.opacity-7 { + opacity: 0.7; +} + +.opacity-8 { + opacity: 0.8; +} + +.opacity-9 { + opacity: 0.9; +} + +.opacity-10 { + opacity: 1; +} + +/* Background light */ +.bg-light-1 { + background-color: $gray-200 !important; +} + +.bg-light-2 { + background-color: $gray-300 !important; +} + +.bg-light-3 { + background-color: $gray-400 !important; +} + +.bg-light-4 { + background-color: $gray-500 !important; +} + + +/* Background Dark */ +.bg-dark { + background-color: #111418 !important; +} + +.bg-dark-1 { + background-color: $gray-900 !important; +} + +.bg-dark-2 { + background-color: $gray-800 !important; +} + +.bg-dark-3 { + background-color: $gray-700 !important; +} + +.bg-dark-4 { + background-color: $gray-600 !important; +} + + +/* Progress Bar */ +.progress-sm { + height: 0.5rem !important; +} + +.progress-lg { + height: 1.5rem !important; +} + +hr{ + border-top:1px solid rgba(16,85,96,.1); +} \ No newline at end of file diff --git a/docs/assets/sass/_layouts.scss b/docs/assets/sass/_layouts.scss new file mode 100644 index 0000000..2ec1e1a --- /dev/null +++ b/docs/assets/sass/_layouts.scss @@ -0,0 +1,171 @@ +/* =================================== */ +/* 3. Layouts +/* =================================== */ + +#main-wrapper { + background:#fff; +} + +.box { + #main-wrapper { + max-width: 1200px; + margin: 0 auto; + @include box-shadow(0px 0px 10px rgba(0, 0, 0, 0.1)); + } + .idocs-navigation { + left: auto; + } +} + + +@include media-breakpoint-up(xl) { + .container { + max-width: 1170px !important; + } +} + + +/*=== 3.1 Side Navigation ===*/ + +.idocs-navigation { + position: fixed; + top: 70px; + left: 0; + overflow: hidden; + overflow-y: auto; + width: 260px; + height: calc(100% - 70px); + z-index: 1; + border-right: 1px solid rgba(0, 0, 0, 0.05); + transition: all 0.3s; + > .nav { + padding: 30px 0; + } + .nav { + .nav-item { + position: relative; + } + .nav { + margin: 0 0 5px; + } + .nav-link { + position: relative; + padding: 6px 30px; + line-height: 25px; + font-weight: 600; + } + .nav-item { + &:hover > .nav-link, .nav-link.active { + font-weight: 700; + } + } + .nav { + .nav-item .nav-link { + &:after { + content: ""; + position: absolute; + left: 30px; + height: 100%; + border-left: 1px solid rgba(0, 0, 0, 0.12); + width: 1px; + top: 0; + } + &.active:after { + border-color: $primary-color; + border-width: 2px; + } + } + display: none; + border-left: 1px solid regba(0, 0, 0, 0.3); + } + .nav-item .nav-link.active + .nav { + display: block; + } + .nav { + .nav-link { + color: #6a6a6a; + padding: 4px 30px 4px 45px; + font-size: 15px; + text-transform: none; + } + .nav { + .nav-link { + padding: 4px 30px 4px 60px; + font-size: 15px; + } + .nav-item .nav-link:after { + left: 45px; + } + } + } + } + > .nav > .nav-item > .nav-link.active:after { + position: absolute; + content: " "; + top: 50%; + right: 18px; + border-color: #000; + border-top: 2px solid; + border-right: 2px solid; + width: 7px; + height: 7px; + -webkit-transform: translate(-50%, -50%) rotate(45deg); + transform: translate(-50%, -50%) rotate(45deg); + @include transition(all .2s ease); + } + &.docs-navigation-dark .nav { + .nav-link { + color: rgba(250, 250, 250, 0.85); + } + .nav { + .nav-link { + color: rgba(250, 250, 250, 0.7); + } + .nav-item .nav-link { + &:after { + border-color: rgba(250, 250, 250, 0.2); + } + &.active:after { + border-color: $primary-color; + } + } + } + } +} + +/*=== 3.2 Docs Content ===*/ + +.idocs-content { + position: relative; + margin-left: 260px; + padding: 0px 50px 50px; + min-height: 750px; + transition: all 0.3s; + + section:first-child { + padding-top: 3rem; + } + ol li, ul li { + margin-top: 10px; + } + +} + + +@include media-breakpoint-down(sm) { +.idocs-navigation { + margin-left: -260px; + + &.active { + margin-left: 0; + } +} +.idocs-content { + margin-left:0px; + padding:0px; +} +} + +/*=== 3.3 Section Divider ===*/ + +.divider{margin: 4rem 0;} diff --git a/docs/assets/sass/_mixins.scss b/docs/assets/sass/_mixins.scss new file mode 100644 index 0000000..a49c550 --- /dev/null +++ b/docs/assets/sass/_mixins.scss @@ -0,0 +1,31 @@ +//---------- @mixins ----------// + +@mixin box-shadow($val...) { + -webkit-box-shadow: ($val); + box-shadow: ($val); +} + +@mixin transition($val...) { + -webkit-transition: ($val); + transition: ($val); +} + +@mixin translateY($val...) { + -webkit-transform: translateY($val); + transform: translateY($val); +} + +@mixin translateX($val...) { + -webkit-transform: translateX($val); + transform: translateX($val); +} + +@mixin rotate($val){ + -webkit-transform: rotate($val); + transform: rotate($val); +} + +@mixin scale($val){ + -webkit-transform: scale($val); + transform: scale($val); +} \ No newline at end of file diff --git a/docs/assets/sass/_reset.scss b/docs/assets/sass/_reset.scss new file mode 100644 index 0000000..727986c --- /dev/null +++ b/docs/assets/sass/_reset.scss @@ -0,0 +1,164 @@ +/* =================================== */ +/* 1. Basic Style +/* =================================== */ + +body, html { +height:100%; +} + +body { + background: $body-bg; + color: $text-color; +} + +/*-------- Preloader --------*/ +.preloader { + position: fixed; + width: 100%; + height: 100%; + z-index: 999999999 !important; + background-color: #fff; + top: 0; + left: 0; + right: 0; + bottom: 0; + .lds-ellipsis { + display: inline-block; + position: absolute; + width: 80px; + height: 80px; + margin-top: -40px; + margin-left: -40px; + top: 50%; + left: 50%; + div { + position: absolute; + top: 33px; + width: 13px; + height: 13px; + border-radius: 50%; + background: #000; + animation-timing-function: cubic-bezier(0, 1, 1, 0); + &:nth-child(1) { + left: 8px; + animation: lds-ellipsis1 0.6s infinite; + } + &:nth-child(2) { + left: 8px; + animation: lds-ellipsis2 0.6s infinite; + } + &:nth-child(3) { + left: 32px; + animation: lds-ellipsis2 0.6s infinite; + } + &:nth-child(4) { + left: 56px; + animation: lds-ellipsis3 0.6s infinite; + } + } + } +} + +@keyframes lds-ellipsis1 { + 0% { + transform: scale(0); + } + 100% { + transform: scale(1); + } +} + +@keyframes lds-ellipsis3 { + 0% { + transform: scale(1); + } + + 100% { + transform: scale(0); + } +} + +@keyframes lds-ellipsis2 { + 0% { + transform: translate(0, 0); + } + 100% { + transform: translate(24px, 0); + } +} + +/*--- Preloader Magnific Popup ----*/ +.mfp-container .preloader{ + background: transparent; + .lds-ellipsis div{ + background: #fff; + } +} + +::selection { + background: $primary-color; + color: #fff; + text-shadow: none; +} + +code{padding: 2px 5px; background-color: #f9f2f4; border-radius: 4px;} + +form { + padding: 0; + margin: 0; + display: inline; +} + +img { + vertical-align: inherit; +} +a, a:focus { + color: $primary-color; + @include transition(all .2s ease); +} +a:hover, a:active { + color: $primary-color-hover; + + @include transition(all .2s ease); +} + +a:focus, a:active, +.btn.active.focus, +.btn.active:focus, +.btn.focus, +.btn:active.focus, +.btn:active:focus, +.btn:focus, +button:focus, +button:active{ + outline: none; +} + +p { + line-height: 1.8; +} + +blockquote { + border-left: 5px solid #eee; + padding: 10px 20px; +} + +iframe { + border: 0 !important; +} + +h1, h2, h3, h4, h5, h6 { + color: $title-color; + line-height: 1.5; + margin: 0 0 1.5rem 0; + font-family:Roboto, sans-serif; +} + +h1{font-size:3rem;} + +h2{font-size:2.2rem;} + +dl, ol, ul, pre, blockquote, .table{margin-bottom:1.8rem;} + +/*=== Highlight Js ===*/ +.hljs {padding: 1.5rem;} \ No newline at end of file diff --git a/docs/assets/sass/_variables.scss b/docs/assets/sass/_variables.scss new file mode 100644 index 0000000..d2504f9 --- /dev/null +++ b/docs/assets/sass/_variables.scss @@ -0,0 +1,44 @@ +/*=========================================================== + + Template Name: iDocs - One Page Documentation HTML Template + Author: Harnish Design + Template URL: http://demo.harnishdesign.net/html/idocs + Author URL: https://themeforest.net/user/harnishdesign + File Description : Main css file of the template + +================================================= + Table of Contents +================================================= + + 1. Basic + 2. Helpers Classes + 3. Layouts + 3.1 Side Navigation + 3.2 Docs Content + 3.3 Section Divider + 4. Header + 4.1 Main Navigation + 5 Elements + 5.1 List Style + 5.2 Changelog + 5.3 Accordion & Toggle + 5.4 Nav + 5.5 Tabs + 5.6 Popup Img + 5.7 Featured Box + 6 Footer + 6.1 Social Icons + 6.2 Back to Top + 7 Extra + +=======================================================*/ + +//-------------------- Base Colors --------------------// + +$primary-color: #0366d6; +$primary-color-hover: darken($primary-color, 7%); +$secondary-color: $secondary; + +$body-bg: #dddddd; +$text-color: #4c4d4d; +$title-color: #252b33; \ No newline at end of file diff --git a/docs/assets/sass/bootstrap/_alert.scss b/docs/assets/sass/bootstrap/_alert.scss new file mode 100644 index 0000000..da2a98a --- /dev/null +++ b/docs/assets/sass/bootstrap/_alert.scss @@ -0,0 +1,51 @@ +// +// Base styles +// + +.alert { + position: relative; + padding: $alert-padding-y $alert-padding-x; + margin-bottom: $alert-margin-bottom; + border: $alert-border-width solid transparent; + @include border-radius($alert-border-radius); +} + +// Headings for larger alerts +.alert-heading { + // Specified to prevent conflicts of changing $headings-color + color: inherit; +} + +// Provide class for links that match alerts +.alert-link { + font-weight: $alert-link-font-weight; +} + + +// Dismissible alerts +// +// Expand the right padding and account for the close button's positioning. + +.alert-dismissible { + padding-right: $close-font-size + $alert-padding-x * 2; + + // Adjust close link position + .close { + position: absolute; + top: 0; + right: 0; + padding: $alert-padding-y $alert-padding-x; + color: inherit; + } +} + + +// Alternate styles +// +// Generate contextual modifier classes for colorizing the alert. + +@each $color, $value in $theme-colors { + .alert-#{$color} { + @include alert-variant(theme-color-level($color, $alert-bg-level), theme-color-level($color, $alert-border-level), theme-color-level($color, $alert-color-level)); + } +} diff --git a/docs/assets/sass/bootstrap/_badge.scss b/docs/assets/sass/bootstrap/_badge.scss new file mode 100644 index 0000000..42c5d08 --- /dev/null +++ b/docs/assets/sass/bootstrap/_badge.scss @@ -0,0 +1,54 @@ +// Base class +// +// Requires one of the contextual, color modifier classes for `color` and +// `background-color`. + +.badge { + display: inline-block; + padding: $badge-padding-y $badge-padding-x; + @include font-size($badge-font-size); + font-weight: $badge-font-weight; + line-height: 1; + text-align: center; + white-space: nowrap; + vertical-align: baseline; + @include border-radius($badge-border-radius); + @include transition($badge-transition); + + @at-root a#{&} { + @include hover-focus() { + text-decoration: none; + } + } + + // Empty badges collapse automatically + &:empty { + display: none; + } +} + +// Quick fix for badges in buttons +.btn .badge { + position: relative; + top: -1px; +} + +// Pill badges +// +// Make them extra rounded with a modifier to replace v3's badges. + +.badge-pill { + padding-right: $badge-pill-padding-x; + padding-left: $badge-pill-padding-x; + @include border-radius($badge-pill-border-radius); +} + +// Colors +// +// Contextual variations (linked badges get darker on :hover). + +@each $color, $value in $theme-colors { + .badge-#{$color} { + @include badge-variant($value); + } +} diff --git a/docs/assets/sass/bootstrap/_breadcrumb.scss b/docs/assets/sass/bootstrap/_breadcrumb.scss new file mode 100644 index 0000000..a0cf7e2 --- /dev/null +++ b/docs/assets/sass/bootstrap/_breadcrumb.scss @@ -0,0 +1,44 @@ +.breadcrumb { + display: flex; + flex-wrap: wrap; + padding: $breadcrumb-padding-y $breadcrumb-padding-x; + margin-bottom: $breadcrumb-margin-bottom; + @include font-size($breadcrumb-font-size); + list-style: none; + background-color: $breadcrumb-bg; + @include border-radius($breadcrumb-border-radius); +} + +.breadcrumb-item { + display: flex; + + // The separator between breadcrumbs (by default, a forward-slash: "/") + + .breadcrumb-item { + padding-left: $breadcrumb-item-padding; + + &::before { + display: inline-block; // Suppress underlining of the separator in modern browsers + padding-right: $breadcrumb-item-padding; + color: $breadcrumb-divider-color; + content: escape-svg($breadcrumb-divider); + } + } + + // IE9-11 hack to properly handle hyperlink underlines for breadcrumbs built + // without `