[New] CLI & Service Application

.gitattributes

@@ -2,6 +2,7 @@
 # Set default behavior to automatically normalize line endings.
 ###############################################################################
 * text eol=lf
+*.json text eol=lf
 
 ###############################################################################
 # Set default behavior for command prompt diff.
@@ -45,6 +46,10 @@
 *.gif binary
 *.ico binary
 
+# Zip files
+*.zip binary
+*.barc binary
+
 ###############################################################################
 # diff behavior for common document formats
 # 

SpellingExclusions.dic

@@ -0,0 +1,2 @@
+barc
+scripthash

docs/README.md

@@ -0,0 +1,8 @@
+# Table of contents
+
+1. [neo-host](cli/neo-host/README.md)
+   1. [Logs](cli/LOGS.md)
+      1. [Configuration](cli/neo-host/logs.md#Configuration)
+      1. [Filtering](cli/neo-host/logs.md#Example_Filtering)
+
+---

docs/cli/neo-host/README.md

@@ -0,0 +1 @@
+# This section is for `neo-host`.

docs/cli/neo-host/logs.md

@@ -0,0 +1,125 @@
+# Logs
+
+## Running as Service
+
+### Windows
+Uses `Windows Event Log` otherwise uses console.
+
+### Linux
+Uses `syslog` otherwise uses console.
+
+## Configuration
+Reference [Log Levels](https://learn.microsoft.com/en-us/aspnet/core/fundamentals/logging/?view=aspnetcore-8.0#log-level)
+Reference [Log Scopes](https://learn.microsoft.com/en-us/dotnet/core/extensions/logging?tabs=command-line#configure-logging-without-code)
+
+## Scopes
+- `Blockchain.Blocks.{hash}`
+- `Blockchain.Transactions.{hash}`
+- `Blockchain.Contracts.{hash}.Logs`
+- `Blockchain.Contracts.{hash}.Events.{name}`
+
+_Notes:_
+1. _Replace `{hash}` with `ScriptHash`, `transaction hash` or `block hash` basic off it's category._
+1. _Replace `{name}` with the event name of the contract._
+
+## Example Filtering
+
+### All Blockchain Log Data
+
+```json
+  "Logging": {
+    "LogLevel": {
+      "Default": "Information",
+      "Microsoft.Hosting.Lifetime": "Information",
+      "Blockchain": "Trace"
+    }
+  },
+```
+
+**Above Includes**
+- All `Runtime.Log`.
+- All `Runtime.Notify` and contract events.
+- All block data in `json` format.
+- All transaction data in `json` format.
+
+**Log Level**
+- `Debug` - includes Notify events.
+- `Trace` - includes Log events.
+
+---
+
+### All Contract Log Data
+
+```json
+  "Logging": {
+    "LogLevel": {
+      "Default": "Information",
+      "Microsoft.Hosting.Lifetime": "Information",
+      "Blockchain.Contracts": "Trace"
+    }
+  },
+```
+
+**Above Includes**
+- All `Runtime.Log`.
+- All `Runtime.Notify` and contract events.
+
+**Log Level**
+- `Debug` - includes Notify events.
+- `Trace` - includes Log events.
+
+---
+
+### All contracts transfer events.
+
+```json
+  "Logging": {
+    "LogLevel": {
+      "Default": "Information",
+      "Microsoft.Hosting.Lifetime": "Information",
+      "Blockchain.Contracts.*.Events.Transfer": "Debug"
+    }
+  },
+```
+
+### Filter by Contract
+This example we use the `GasToken` native contract; filtering by the `Transfer` event.
+
+1. Add a new `json` section within `LogLevel` section with value `Blockchain.Contracts.{hash}.Events.{name}`.
+1. We replaced `{hash}` with the `scripthash` of the contract; and `{name}` with the event name of the contract.
+1. Set `json` string value to log level `Debug`.
+
+### All events and logs.
+```json
+  "Logging": {
+    "LogLevel": {
+      "Default": "Information",
+      "Microsoft.Hosting.Lifetime": "Information",
+      "Blockchain.Contracts.0xd2a4cff31913016155e38e474a2c06d08be276cf": "Debug"
+    }
+  },
+```
+
+### All events.
+```json
+  "Logging": {
+    "LogLevel": {
+      "Default": "Information",
+      "Microsoft.Hosting.Lifetime": "Information",
+      "Blockchain.Contracts.0xd2a4cff31913016155e38e474a2c06d08be276cf.Events": "Debug"
+    }
+  },
+```
+
+### All transfers.
+```json
+  "Logging": {
+    "LogLevel": {
+      "Default": "Information",
+      "Microsoft.Hosting.Lifetime": "Information",
+      "Blockchain.Contracts.0xd2a4cff31913016155e38e474a2c06d08be276cf.Events.Transfer": "Debug"
+    }
+  },
+```
+
+---

docs/cli/systemd/examples/neo-host.service

@@ -0,0 +1,11 @@
+[Unit]
+Description=NEO N3 blockchain node service
+
+[Service]
+Type=notify
+Restart=always
+TimeoutSec=5
+RestartSec=10
+
+[Install]
+WantedBy=multi-user.target

neo.sln

@@ -36,9 +36,17 @@ Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Neo.Cryptography.BLS12_381"
 EndProject
 Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Neo.Cryptography.BLS12_381.Tests", "tests\Neo.Cryptography.BLS12_381.Tests\Neo.Cryptography.BLS12_381.Tests.csproj", "{387CCF6C-9A26-43F6-A639-0A82E91E10D8}"
 EndProject
-Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Neo.IO", "src\Neo.IO\Neo.IO.csproj", "{4CDAC1AA-45C6-4157-8D8E-199050433048}"
+Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Neo.Service", "src\Neo.Service\Neo.Service.csproj", "{A680BEF0-6895-4DA6-A355-304EEC9B4861}"
 EndProject
-Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Neo.Extensions", "src\Neo.Extensions\Neo.Extensions.csproj", "{9C5213D6-3833-4570-8AE2-47E9F9017A8F}"
+Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Neo.Service.Tests", "tests\Neo.Service.Test\Neo.Service.Tests.csproj", "{6400F5B3-CFD6-4F95-A733-94A326B14B2C}"
+EndProject
+Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Neo.IO", "src\Neo.IO\Neo.IO.csproj", "{4CDAC1AA-45C6-4157-8D8E-199050433048}"
+EndProject
+Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Neo.Extensions", "src\Neo.Extensions\Neo.Extensions.csproj", "{9C5213D6-3833-4570-8AE2-47E9F9017A8F}"
+EndProject
+Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Neo.IO.Tests", "tests\Neo.IO.Tests\Neo.IO.Tests.csproj", "{25D79A08-52D9-4808-A53F-E0C9626DDCBB}"
+EndProject
+Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Neo.Service.App", "src\Neo.Service.App\Neo.Service.App.csproj", "{2038D34A-C024-4207-8E22-600E98C33146}"
 EndProject
 Global
 	GlobalSection(SolutionConfigurationPlatforms) = preSolution
@@ -102,6 +110,14 @@ Global
 		{387CCF6C-9A26-43F6-A639-0A82E91E10D8}.Debug|Any CPU.Build.0 = Debug|Any CPU
 		{387CCF6C-9A26-43F6-A639-0A82E91E10D8}.Release|Any CPU.ActiveCfg = Release|Any CPU
 		{387CCF6C-9A26-43F6-A639-0A82E91E10D8}.Release|Any CPU.Build.0 = Release|Any CPU
+		{A680BEF0-6895-4DA6-A355-304EEC9B4861}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{A680BEF0-6895-4DA6-A355-304EEC9B4861}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{A680BEF0-6895-4DA6-A355-304EEC9B4861}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{A680BEF0-6895-4DA6-A355-304EEC9B4861}.Release|Any CPU.Build.0 = Release|Any CPU
+		{6400F5B3-CFD6-4F95-A733-94A326B14B2C}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{6400F5B3-CFD6-4F95-A733-94A326B14B2C}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{6400F5B3-CFD6-4F95-A733-94A326B14B2C}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{6400F5B3-CFD6-4F95-A733-94A326B14B2C}.Release|Any CPU.Build.0 = Release|Any CPU
 		{4CDAC1AA-45C6-4157-8D8E-199050433048}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
 		{4CDAC1AA-45C6-4157-8D8E-199050433048}.Debug|Any CPU.Build.0 = Debug|Any CPU
 		{4CDAC1AA-45C6-4157-8D8E-199050433048}.Release|Any CPU.ActiveCfg = Release|Any CPU
@@ -110,6 +126,14 @@ Global
 		{9C5213D6-3833-4570-8AE2-47E9F9017A8F}.Debug|Any CPU.Build.0 = Debug|Any CPU
 		{9C5213D6-3833-4570-8AE2-47E9F9017A8F}.Release|Any CPU.ActiveCfg = Release|Any CPU
 		{9C5213D6-3833-4570-8AE2-47E9F9017A8F}.Release|Any CPU.Build.0 = Release|Any CPU
+		{25D79A08-52D9-4808-A53F-E0C9626DDCBB}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{25D79A08-52D9-4808-A53F-E0C9626DDCBB}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{25D79A08-52D9-4808-A53F-E0C9626DDCBB}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{25D79A08-52D9-4808-A53F-E0C9626DDCBB}.Release|Any CPU.Build.0 = Release|Any CPU
+		{2038D34A-C024-4207-8E22-600E98C33146}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{2038D34A-C024-4207-8E22-600E98C33146}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{2038D34A-C024-4207-8E22-600E98C33146}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{2038D34A-C024-4207-8E22-600E98C33146}.Release|Any CPU.Build.0 = Release|Any CPU
 	EndGlobalSection
 	GlobalSection(SolutionProperties) = preSolution
 		HideSolutionNode = FALSE
@@ -129,8 +153,12 @@ Global
 		{B40F8584-5AFB-452C-AEFA-009C80CC23A9} = {EDE05FA8-8E73-4924-BC63-DD117127EEE1}
 		{D48C1FAB-3471-4CA0-8688-25E6F43F2C25} = {B5339DF7-5D1D-43BA-B332-74B825E1770E}
 		{387CCF6C-9A26-43F6-A639-0A82E91E10D8} = {EDE05FA8-8E73-4924-BC63-DD117127EEE1}
+		{A680BEF0-6895-4DA6-A355-304EEC9B4861} = {B5339DF7-5D1D-43BA-B332-74B825E1770E}
+		{6400F5B3-CFD6-4F95-A733-94A326B14B2C} = {EDE05FA8-8E73-4924-BC63-DD117127EEE1}
 		{4CDAC1AA-45C6-4157-8D8E-199050433048} = {B5339DF7-5D1D-43BA-B332-74B825E1770E}
 		{9C5213D6-3833-4570-8AE2-47E9F9017A8F} = {B5339DF7-5D1D-43BA-B332-74B825E1770E}
+		{25D79A08-52D9-4808-A53F-E0C9626DDCBB} = {EDE05FA8-8E73-4924-BC63-DD117127EEE1}
+		{2038D34A-C024-4207-8E22-600E98C33146} = {B5339DF7-5D1D-43BA-B332-74B825E1770E}
 	EndGlobalSection
 	GlobalSection(ExtensibilityGlobals) = postSolution
 		SolutionGuid = {BCBA19D9-F868-4C6D-8061-A2B91E06E3EC}

src/Neo.Extensions/AssemblyUtilities.cs

@@ -0,0 +1,25 @@
+// Copyright (C) 2015-2024 The Neo Project.
+//
+// AssemblyUtilities.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.Reflection;
+
+namespace Neo.Extensions
+{
+    public static class AssemblyUtilities
+    {
+        public static int GetVersionNumber()
+        {
+            var version = Assembly.GetCallingAssembly().GetName().Version;
+            if (version is null) return 0;
+            return version.Major * 1000 + version.Minor * 100 + version.Build * 10 + version.Revision;
+        }
+    }
+}

src/Neo.Extensions/LogLevel.cs

@@ -41,6 +41,11 @@ public enum LogLevel : byte
         /// <summary>
         /// The fatal log level.
         /// </summary>
-        Fatal = Error + 1
+        Fatal = Error + 1,
+
+        /// <summary>
+        /// The trace log level.
+        /// </summary>
+        Trace = Fatal + 1,
     }
 }

src/Neo.IO/Neo.IO.csproj

@@ -10,6 +10,7 @@
   <ItemGroup>
     <InternalsVisibleTo Include="Neo" />
     <InternalsVisibleTo Include="Neo.UnitTests" />
+    <InternalsVisibleTo Include="neo-cmd" />
     <InternalsVisibleTo Include="$(AssemblyName).Tests" />
   </ItemGroup>
 

src/Neo.Service.App/Buffers/MemoryPoolBlock.cs

@@ -0,0 +1,44 @@
+// Copyright (C) 2015-2024 The Neo Project.
+//
+// MemoryPoolBlock.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.Buffers;
+using System.Runtime.InteropServices;
+
+namespace Neo.Service.App.Buffers
+{
+    internal sealed class MemoryPoolBlock : IMemoryOwner<byte>
+    {
+        public PinnedBlockMemoryPool Pool { get; }
+
+        internal MemoryPoolBlock(
+            PinnedBlockMemoryPool pool,
+            int length)
+        {
+            Pool = pool;
+
+            var pinnedArray = GC.AllocateUninitializedArray<byte>(length, pinned: true);
+
+            Memory = MemoryMarshal.CreateFromPinnedArray(pinnedArray, 0, pinnedArray.Length);
+        }
+
+        #region IMemoryOwner
+
+        public Memory<byte> Memory { get; }
+
+        void IDisposable.Dispose()
+        {
+            Pool.Return(this);
+        }
+
+        #endregion
+    }
+}

src/Neo.Service.App/Buffers/PinnedBlockMemoryPool.cs

@@ -0,0 +1,68 @@
+// Copyright (C) 2015-2024 The Neo Project.
+//
+// PinnedBlockMemoryPool.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.Buffers;
+using System.Collections.Concurrent;
+
+namespace Neo.Service.App.Buffers
+{
+    internal sealed class PinnedBlockMemoryPool : MemoryPool<byte>
+    {
+        private const int AnySize = -1;
+
+        private static readonly int s_blockSize = 4096;
+
+        public static int BlockSize => s_blockSize;
+
+        public override int MaxBufferSize { get; } = s_blockSize;
+
+        private readonly ConcurrentQueue<MemoryPoolBlock> _blocks = new();
+        private readonly object _disposedSync = new();
+
+        private bool _isDisposed;
+
+        public override IMemoryOwner<byte> Rent(int size = AnySize)
+        {
+            ArgumentOutOfRangeException.ThrowIfGreaterThan(size, s_blockSize);
+            ObjectDisposedException.ThrowIf(_isDisposed, this);
+
+            if (_blocks.TryDequeue(out var block))
+                return block;
+
+            return new MemoryPoolBlock(this, BlockSize);
+        }
+
+        internal void Return(MemoryPoolBlock block)
+        {
+            if (_isDisposed == false)
+                _blocks.Enqueue(block);
+        }
+
+        protected override void Dispose(bool disposing)
+        {
+            if (_isDisposed)
+                return;
+
+            lock (_disposedSync)
+            {
+                _isDisposed = true;
+
+                if (disposing)
+                {
+                    while (_blocks.TryDequeue(out _))
+                    {
+                    }
+                }
+            }
+        }
+    }
+}