RPC-JSON over WebSockets

neo-modules.sln

@@ -43,6 +43,8 @@ Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "SQLiteWallet", "src\SQLiteW
 EndProject
 Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "StorageDumper", "src\StorageDumper\StorageDumper.csproj", "{938D86EA-0F48-436B-9255-4AD9A8E6B9AC}"
 EndProject
+Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "WsRpcJsonServer", "src\WebSocketServer\WsRpcJsonServer.csproj", "{BAB59C2B-BBD6-4977-9CEA-FFAD45150204}"
+EndProject
 Global
 	GlobalSection(SolutionConfigurationPlatforms) = preSolution
 		Debug|Any CPU = Debug|Any CPU
@@ -121,6 +123,10 @@ Global
 		{938D86EA-0F48-436B-9255-4AD9A8E6B9AC}.Debug|Any CPU.Build.0 = Debug|Any CPU
 		{938D86EA-0F48-436B-9255-4AD9A8E6B9AC}.Release|Any CPU.ActiveCfg = Release|Any CPU
 		{938D86EA-0F48-436B-9255-4AD9A8E6B9AC}.Release|Any CPU.Build.0 = Release|Any CPU
+		{BAB59C2B-BBD6-4977-9CEA-FFAD45150204}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{BAB59C2B-BBD6-4977-9CEA-FFAD45150204}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{BAB59C2B-BBD6-4977-9CEA-FFAD45150204}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{BAB59C2B-BBD6-4977-9CEA-FFAD45150204}.Release|Any CPU.Build.0 = Release|Any CPU
 	EndGlobalSection
 	GlobalSection(SolutionProperties) = preSolution
 		HideSolutionNode = FALSE
@@ -144,6 +150,7 @@ Global
 		{8D2EE375-2E2D-45FE-A4E9-0254D12C7554} = {59D802AB-C552-422A-B9C3-64D329FBCDCC}
 		{D121D57A-512E-4F74-ADA1-24482BF5C42B} = {97E81C78-1637-481F-9485-DA1225E94C23}
 		{938D86EA-0F48-436B-9255-4AD9A8E6B9AC} = {97E81C78-1637-481F-9485-DA1225E94C23}
+		{BAB59C2B-BBD6-4977-9CEA-FFAD45150204} = {97E81C78-1637-481F-9485-DA1225E94C23}
 	EndGlobalSection
 	GlobalSection(ExtensibilityGlobals) = postSolution
 		SolutionGuid = {61D3ADE6-BBFC-402D-AB42-1C71C9F9EDE3}

src/WebSocketServer/Models/NeoUtilityLogResult.cs

@@ -0,0 +1,41 @@
+// Copyright (C) 2015-2024 The Neo Project.
+//
+// NeoUtilityLogResult.cs file belongs to the neo project and is free
+// software distributed under the MIT software license, see the
+// accompanying file LICENSE in the main directory of the
+// repository or http://www.opensource.org/licenses/mit-license.php
+// for more details.
+//
+// Redistribution and use in source and binary forms with or without
+// modifications are permitted.
+
+using Neo.Json;
+
+namespace Neo.Plugins.WsRpcJsonServer.Models
+{
+    internal class NeoUtilityLogResult
+    {
+        public string? SourceName { get; init; }
+        public LogLevel LogLevel { get; init; }
+        public object? Message { get; init; }
+
+        public static NeoUtilityLogResult Create(string sourceName, LogLevel level, object message) =>
+            new()
+            {
+                SourceName = sourceName,
+                LogLevel = level,
+                Message = message
+            };
+
+        public override string ToString() =>
+            $"{ToJson()}";
+
+        public JToken ToJson() =>
+            new JObject()
+            {
+                ["source"] = SourceName,
+                ["level"] = $"{LogLevel}",
+                ["message"] = $"{Message}",
+            };
+    }
+}

src/WebSocketServer/Models/RpcJsonRequestMessage.cs

@@ -0,0 +1,34 @@
+// Copyright (C) 2015-2024 The Neo Project.
+//
+// RpcJsonRequestMessage.cs file belongs to the neo project and is free
+// software distributed under the MIT software license, see the
+// accompanying file LICENSE in the main directory of the
+// repository or http://www.opensource.org/licenses/mit-license.php
+// for more details.
+//
+// Redistribution and use in source and binary forms with or without
+// modifications are permitted.
+
+using Neo.Json;
+using System;
+
+namespace Neo.Plugins.WsRpcJsonServer.Models
+{
+    internal class RpcJsonRequestMessage
+    {
+        public Version? Version { get; set; }
+        public int Id { get; set; }
+        public string? Method { get; set; }
+        public JArray? Params { get; set; }
+
+        public static RpcJsonRequestMessage FromJson(JToken? message) =>
+            new()
+            {
+                Version = message?["jsonrpc"] == null ? null : new(message["jsonrpc"]!.AsString()),
+                Id = message?["id"] == null ? 0 : unchecked((int)message["id"]!.AsNumber()),
+                Method = message?["method"]?.AsString(),
+                Params = message?["params"] == null ? null : message["params"]! as JArray,
+            };
+
+    }
+}

src/WebSocketServer/Models/RpcJsonResponseMessage.cs

@@ -0,0 +1,66 @@
+// Copyright (C) 2015-2024 The Neo Project.
+//
+// RpcJsonResponseMessage.cs file belongs to the neo project and is free
+// software distributed under the MIT software license, see the
+// accompanying file LICENSE in the main directory of the
+// repository or http://www.opensource.org/licenses/mit-license.php
+// for more details.
+//
+// Redistribution and use in source and binary forms with or without
+// modifications are permitted.
+
+using Neo.Json;
+using System;
+using System.Text;
+
+namespace Neo.Plugins.Models.WsRpcJsonServer
+{
+    internal class RpcJsonResponseMessage : IEquatable<RpcJsonResponseMessage>
+    {
+        public Version Version { get; private init; } = new("2.0");
+        public int Id { get; private init; }
+        public JToken? Result { get; private init; }
+
+        internal static RpcJsonResponseMessage Create(int id, JToken result) =>
+            new()
+            {
+                Id = id,
+                Result = result,
+            };
+
+        public JToken ToJson() =>
+            new JObject()
+            {
+                ["jsonrpc"] = $"{Version}",
+                ["id"] = Id,
+                ["result"] = Result,
+            };
+
+        public static RpcJsonResponseMessage FromJson(JToken message) =>
+            new()
+            {
+                Version = message["jsonrpc"] == null ? new("1.0") : new(message["jsonrpc"]!.AsString()),
+                Id = message["id"] == null ? 0 : unchecked((int)message["id"]!.AsNumber()),
+                Result = message["result"],
+            };
+
+        public override string ToString() =>
+            $"{ToJson()}";
+
+        public byte[] ToArray() =>
+            Encoding.UTF8.GetBytes(ToString());
+
+        public bool Equals(RpcJsonResponseMessage? other) =>
+            other != null && other.Id == Id &&
+            other.Version == Version && other.Result == Result;
+
+        public override bool Equals(object? obj)
+        {
+            if (ReferenceEquals(this, obj)) return true;
+            return Equals(obj as RpcJsonResponseMessage);
+        }
+
+        public override int GetHashCode() =>
+            HashCode.Combine(this, Version, Id, Result);
+    }
+}

src/WebSocketServer/WalletSession.cs

@@ -0,0 +1,32 @@
+// Copyright (C) 2015-2024 The Neo Project.
+//
+// WalletSession.cs file belongs to the neo project and is free
+// software distributed under the MIT software license, see the
+// accompanying file LICENSE in the main directory of the
+// repository or http://www.opensource.org/licenses/mit-license.php
+// for more details.
+//
+// Redistribution and use in source and binary forms with or without
+// modifications are permitted.
+
+using Neo.Wallets;
+using System;
+
+namespace Neo.Plugins.WsRpcJsonServer
+{
+    public class WalletSession
+    {
+        public Wallet Wallet { get; private init; }
+        public DateTime Expires { get; private set; }
+
+        public WalletSession(
+            Wallet wallet)
+        {
+            Wallet = wallet;
+            ResetExpiration();
+        }
+
+        public void ResetExpiration() =>
+            Expires = DateTime.UtcNow.AddSeconds(WsRpcJsonKestrelSettings.Current?.WalletSessionTimeout ?? WsRpcJsonKestrelSettings.Default.WalletSessionTimeout);
+    }
+}

src/WebSocketServer/WalletSessionManager.cs

@@ -0,0 +1,43 @@
+// Copyright (C) 2015-2024 The Neo Project.
+//
+// WalletSessionManager.cs file belongs to the neo project and is free
+// software distributed under the MIT software license, see the
+// accompanying file LICENSE in the main directory of the
+// repository or http://www.opensource.org/licenses/mit-license.php
+// for more details.
+//
+// Redistribution and use in source and binary forms with or without
+// modifications are permitted.
+
+using System;
+using System.Collections.Concurrent;
+using System.Linq;
+using System.Threading;
+using System.Threading.Tasks;
+
+namespace Neo.Plugins.WsRpcJsonServer
+{
+    public class WalletSessionManager : ConcurrentDictionary<Guid, WalletSession>
+    {
+        private readonly PeriodicTimer _timer;
+
+        public WalletSessionManager()
+        {
+            _timer = new(TimeSpan.FromSeconds(1));
+            _ = Task.Run(SessionTimeoutAsync);
+        }
+
+        private async Task SessionTimeoutAsync()
+        {
+            while (await _timer.WaitForNextTickAsync())
+            {
+                var killAll = this.Where(w => w.Value.Expires <= DateTime.UtcNow)
+                    .Select(s => Task.Run(() =>
+                    {
+                        TryRemove(s);
+                    }));
+                await Task.WhenAll(killAll);
+            }
+        }
+    }
+}

src/WebSocketServer/WebSocketChannel.cs

@@ -0,0 +1,28 @@
+// Copyright (C) 2015-2024 The Neo Project.
+//
+// WebSocketChannel.cs file belongs to the neo project and is free
+// software distributed under the MIT software license, see the
+// accompanying file LICENSE in the main directory of the
+// repository or http://www.opensource.org/licenses/mit-license.php
+// for more details.
+//
+// Redistribution and use in source and binary forms with or without
+// modifications are permitted.
+
+using Neo.Json;
+
+namespace Neo.Plugins.WsRpcJsonServer
+{
+    internal class WebSocketChannel
+    {
+        public WebSocketChannelType? ChannelType { get; private init; }
+        public JToken? Params { get; private init; }
+
+        public static WebSocketChannel Create(WebSocketChannelType channelType, JToken? args) =>
+            new()
+            {
+                ChannelType = channelType,
+                Params = args ?? JToken.Null,
+            };
+    }
+}

src/WebSocketServer/WebSocketChannelType.cs

@@ -0,0 +1,24 @@
+// Copyright (C) 2015-2024 The Neo Project.
+//
+// WebSocketChannelType.cs file belongs to the neo project and is free
+// software distributed under the MIT software license, see the
+// accompanying file LICENSE in the main directory of the
+// repository or http://www.opensource.org/licenses/mit-license.php
+// for more details.
+//
+// Redistribution and use in source and binary forms with or without
+// modifications are permitted.
+
+namespace Neo.Plugins.WsRpcJsonServer
+{
+    public enum WebSocketChannelType : byte
+    {
+        Block = 0x02,               // Blockchain.Committed
+        MemoryPool = 0x03,          // MemoryPool
+        Transaction = 0x05,         // Transaction
+        ContractNotify = 0x14,      // ApplicationEngine.Notify
+        AppLog = 0x15,              // ApplicationEngine.Log
+        DebugLog = 0x16,            // Utility.Log
+        Error = 0x19,               // Error(s)
+    }
+}