add logs to execution

src/ApplicationLogs/LogReader.cs

@@ -176,8 +176,13 @@ private void OnCommitting(NeoSystem system, Block block, DataCache snapshot, IRe
             foreach (var appExec in applicationExecutedList.Where(p => p.Transaction != null))
             {
                 var txJson = TxLogToJson(appExec);
+                if (RpcServer.LogEvents.TryGetValue(appExec.Transaction.Hash, out var list))
+                {
+                    txJson["logs"] = new JArray(list.Select(q => new JString(q.Message)));
+                }
                 Put(appExec.Transaction.Hash.ToArray(), Neo.Utility.StrictUTF8.GetBytes(txJson.ToString()));
             }
+            RpcServer.LogEvents.Clear();
 
             //processing log for block
             var blockJson = BlockLogToJson(block, applicationExecutedList);

src/RpcServer/RpcServer.SmartContract.cs

@@ -121,6 +121,8 @@ private JObject GetInvokeResult(byte[] script, Signer[] signers = null, Witness[
                 lock (sessions)
                     sessions.Add(id, session);
             }
+            if (session.Engine.ScriptContainer is Transaction tx && LogEvents.ContainsKey(tx.Hash))
+                json["logs"] = new JArray(LogEvents[tx.Hash].Select(p => new JString(p.Message)));
             return json;
         }
 
@@ -197,7 +199,7 @@ private static Witness[] WitnessesFromJson(JArray _params)
         [RpcMethod]
         protected virtual JObject InvokeFunction(JArray _params)
         {
-            UInt160 script_hash = UInt160.Parse(_params[0].AsString());
+            UInt160 scriptHash = UInt160.Parse(_params[0].AsString());
             string operation = _params[1].AsString();
             ContractParameter[] args = _params.Count >= 3 ? ((JArray)_params[2]).Select(p => ContractParameter.FromJson(p)).ToArray() : System.Array.Empty<ContractParameter>();
             Signer[] signers = _params.Count >= 4 ? SignersFromJson((JArray)_params[3], system.Settings) : null;
@@ -207,7 +209,7 @@ protected virtual JObject InvokeFunction(JArray _params)
             byte[] script;
             using (ScriptBuilder sb = new())
             {
-                script = sb.EmitDynamicCall(script_hash, operation, args).ToArray();
+                script = sb.EmitDynamicCall(scriptHash, operation, args).ToArray();
             }
             return GetInvokeResult(script, signers, witnesses, useDiagnostic);
         }
@@ -260,20 +262,20 @@ protected virtual JObject GetUnclaimedGas(JArray _params)
         {
             string address = _params[0].AsString();
             JObject json = new();
-            UInt160 script_hash;
+            UInt160 scriptHash;
             try
             {
-                script_hash = AddressToScriptHash(address, system.Settings.AddressVersion);
+                scriptHash = AddressToScriptHash(address, system.Settings.AddressVersion);
             }
             catch
             {
-                script_hash = null;
+                scriptHash = null;
             }
-            if (script_hash == null)
+            if (scriptHash == null)
                 throw new RpcException(-100, "Invalid address");
             var snapshot = system.StoreView;
-            json["unclaimed"] = NativeContract.NEO.UnclaimedGas(snapshot, script_hash, NativeContract.Ledger.CurrentIndex(snapshot) + 1).ToString();
-            json["address"] = script_hash.ToAddress(system.Settings.AddressVersion);
+            json["unclaimed"] = NativeContract.NEO.UnclaimedGas(snapshot, scriptHash, NativeContract.Ledger.CurrentIndex(snapshot) + 1).ToString();
+            json["address"] = scriptHash.ToAddress(system.Settings.AddressVersion);
             return json;
         }
 

src/RpcServer/RpcServer.cs

@@ -15,7 +15,6 @@
 using Microsoft.AspNetCore.ResponseCompression;
 using Microsoft.AspNetCore.Server.Kestrel.Https;
 using Microsoft.Extensions.DependencyInjection;
-using Neo.IO;
 using Neo.IO.Json;
 using Neo.Network.P2P;
 using System;
@@ -28,6 +27,9 @@
 using System.Security.Cryptography.X509Certificates;
 using System.Text;
 using System.Threading.Tasks;
+using Neo.Ledger;
+using Neo.Network.P2P.Payloads;
+using Neo.SmartContract;
 
 namespace Neo.Plugins
 {
@@ -39,6 +41,15 @@ public partial class RpcServer : IDisposable
         private RpcServerSettings settings;
         private readonly NeoSystem system;
         private readonly LocalNode localNode;
+        /// <summary>
+        /// Public interface of _logEvents.
+        /// </summary>
+        public static Dictionary<UInt256, Queue<LogEventArgs>> LogEvents { get; } = new();
+
+        /// <summary>
+        /// Maximum number of events to be logged per contract
+        /// </summary>
+        private const int MaxLogEvents = 50;
 
         public RpcServer(NeoSystem system, RpcServerSettings settings)
         {
@@ -47,6 +58,14 @@ public RpcServer(NeoSystem system, RpcServerSettings settings)
             localNode = system.LocalNode.Ask<LocalNode>(new LocalNode.GetInstance()).Result;
             RegisterMethods(this);
             Initialize_SmartContract();
+
+            ApplicationEngine.Log += OnContractLogEvent;
+            Blockchain.Committed += OnCommitted;
+        }
+
+        private void OnCommitted(NeoSystem system, Block block)
+        {
+            LogEvents.Clear();
         }
 
         private bool CheckAuth(HttpContext context)
@@ -92,8 +111,28 @@ private static JObject CreateResponse(JObject id)
             return response;
         }
 
+        // It is potentially possible to have dos attack by sending a lot of transactions and logs.
+        // To prevent this, we limit the number of logs to be logged per contract.
+        // If the number of logs is greater than MAX_LOG_EVENTS, we remove the oldest log.
+        private static void OnContractLogEvent(object _, LogEventArgs e)
+        {
+            if (e.ScriptContainer is not Transaction tx) return;
+            if (!LogEvents.TryGetValue(tx.Hash, out var _logs))
+            {
+                _logs = new Queue<LogEventArgs>();
+                LogEvents.Add(tx.Hash, _logs);
+            }
+            if (LogEvents[tx.Hash].Count >= MaxLogEvents)
+            {
+                _logs.Dequeue();
+            }
+            _logs.Enqueue(e);
+        }
+
         public void Dispose()
         {
+            Blockchain.Committed -= OnCommitted;
+            ApplicationEngine.Log -= OnContractLogEvent;
             Dispose_SmartContract();
             if (host != null)
             {

src/RpcServer/RpcServer.csproj

@@ -4,5 +4,9 @@
     <PackageId>Neo.Plugins.RpcServer</PackageId>
     <RootNamespace>Neo.Plugins</RootNamespace>
   </PropertyGroup>
+
+  <ItemGroup>
+    <ProjectReference Include="..\RpcClient\RpcClient.csproj" />
+  </ItemGroup>
 
 </Project>

src/RpcServer/RpcServerPlugin.cs

@@ -10,6 +10,9 @@
 
 using System.Collections.Generic;
 using System.Linq;
+using Neo.Ledger;
+using Neo.Network.P2P.Payloads;
+using Neo.SmartContract;
 
 namespace Neo.Plugins
 {
@@ -30,13 +33,6 @@ protected override void Configure()
                     server.UpdateSettings(s);
         }
 
-        public override void Dispose()
-        {
-            foreach (var (_, server) in servers)
-                server.Dispose();
-            base.Dispose();
-        }
-
         protected override void OnSystemLoaded(NeoSystem system)
         {
             RpcServerSettings s = settings.Servers.FirstOrDefault(p => p.Network == system.Settings.Network);
@@ -56,6 +52,13 @@ protected override void OnSystemLoaded(NeoSystem system)
             servers.TryAdd(s.Network, server);
         }
 
+        public override void Dispose()
+        {
+            foreach (var (_, server) in servers)
+                server.Dispose();
+            base.Dispose();
+        }
+
         public static void RegisterMethods(object handler, uint network)
         {
             if (servers.TryGetValue(network, out RpcServer server))