[New] CLI & Service Application

.github/workflows/main.yml

@@ -80,6 +80,7 @@ jobs:
         dotnet test ./tests/Neo.UnitTests --output ./bin/tests/Neo.UnitTests
         dotnet test ./tests/Neo.VM.Tests --output ./bin/tests/Neo.VM.Tests
         dotnet test ./tests/Neo.Json.UnitTests --output ./bin/tests/Neo.Json.UnitTests
+        dotnet test ./tests/Neo.Hosting.App.Tests --output ./bin/tests/Neo.Hosting.App.Tests
 
         # Plugins
         dotnet test ./tests/Neo.Cryptography.MPTTrie.Tests --output ./bin/tests/Neo.Cryptography.MPTTrie.Tests
@@ -104,6 +105,7 @@ jobs:
           ${{ github.workspace }}/tests/Neo.Plugins.OracleService.Tests/TestResults/coverage.info
           ${{ github.workspace }}/tests/Neo.Plugins.RpcServer.Tests/TestResults/coverage.info
           ${{ github.workspace }}/tests/Neo.Plugins.Storage.Tests/TestResults/coverage.info
+          ${{ github.workspace }}/tests/Neo.Hosting.App.Tests/TestResults/coverage.info
 
   PublishPackage:
     if: github.ref == 'refs/heads/master' && startsWith(github.repository, 'neo-project/')

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-cmd/README.md

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

docs/cli/neo-cmd/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/neo-cmd/neo-cmd.md

@@ -0,0 +1,64 @@
+# URI Scheme
+
+## Syntax
+
+The URI generic syntax consists of five components organized hierarchically in order of decreasing significance from left to right:
+
+```
+URI = scheme ":" [socket ":"] ["//" authority] path ["#" fragment]
+```
+
+A component is undefined if it has an associated delimiter and the delimiter does not appear in the URI; the scheme and path components are always defined. A component is empty if it has no characters; the scheme component is always non-empty.
+
+The authority component consists of subcomponents:
+
+```
+authority = host [":" port]
+```
+
+The socket component consists of subcomponents:
+```
+socket = tcp | udp
+```
+
+## Examples
+
+MainNet:
+
+```
+neo://+:10333/#860833102
+
+OR
+
+neo:tcp://+:10333/#860833102
+```
+
+TestNet:
+
+```
+neo://+:20333/#894710606
+
+OR
+
+neo:tcp://+:20333/#894710606
+```
+
+### Breakdown
+
+Let's break down the following ***URI***:
+
+> ```
+> neo://127.0.0.1:226/#860833102,#89471060
+> └┬┘   └────┬──────┘│└───────┬──────────┘
+> scheme authority  path   fragment
+> ```
+
+- ***`neo` is the scheme.***
+  - _Application(s) will connect to the ***tcp*** socket by ***default***._
+- ***`//127.0.0.1:226` is the authority. Acts as passthrough to hit the _SeedList_***
+  - _***127.0.0.1:226*** is the host and port the socket will connect too._
+- ***`/` is the path.***
+  - _***/*** doesn't do anything at this time._
+- ***`#860833102,#89471060` is the fragment.***
+  - _***#860833102,#89471060*** are the networks the application wants to join._
+

docs/cli/systemd/examples/neo-cmd.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

@@ -40,6 +40,10 @@ Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Neo.IO", "src\Neo.IO\Neo.IO
 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.Hosting.App", "src\Neo.Hosting.App\Neo.Hosting.App.csproj", "{DF99D759-46D5-4CDB-89CB-EF56DC9728DA}"
+EndProject
+Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Neo.Hosting.App.Tests", "tests\Neo.Hosting.App.Tests\Neo.Hosting.App.Tests.csproj", "{FB1FA9F6-B6B4-48B7-A522-1FAF55DFB228}"
+EndProject
 Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "plugins", "plugins", "{C2DC830A-327A-42A7-807D-295216D30DBB}"
 EndProject
 Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Neo.Cryptography.MPTTrie.Tests", "tests\Neo.Cryptography.MPTTrie.Tests\Neo.Cryptography.MPTTrie.Tests.csproj", "{FAF5D8AC-B6B3-4CD4-879D-0E5F6211480F}"
@@ -50,8 +54,6 @@ Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Neo.Plugins.OracleService.T
 EndProject
 Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Neo.Plugins.RpcServer.Tests", "tests\Neo.Plugins.RpcServer.Tests\Neo.Plugins.RpcServer.Tests.csproj", "{2CBD2311-BA2E-4921-A000-FDDA59B74958}"
 EndProject
-Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Neo.Plugins.Storage.Tests", "tests\Neo.Plugins.Storage.Tests\Neo.Plugins.Storage.Tests.csproj", "{EF01E062-DBBC-47AF-AF3B-9EDEB00CFF7C}"
-EndProject
 Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "tests", "tests", "{7F257712-D033-47FF-B439-9D4320D06599}"
 EndProject
 Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "ApplicationLogs", "src\Plugins\ApplicationLogs\ApplicationLogs.csproj", "{22E2CE64-080B-4138-885F-7FA74A9159FB}"
@@ -78,6 +80,8 @@ Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "TokensTracker", "src\Plugin
 EndProject
 Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "RpcClient", "src\Plugins\RpcClient\RpcClient.csproj", "{185ADAFC-BFC6-413D-BC2E-97F9FB0A8AF0}"
 EndProject
+Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Neo.Plugins.Storage.Tests", "tests\Neo.Plugins.Storage.Tests\Neo.Plugins.Storage.Tests.csproj", "{9B6BC5EC-EC11-408C-BFBA-C7ABD732F5B8}"
+EndProject
 Global
 	GlobalSection(SolutionConfigurationPlatforms) = preSolution
 		Debug|Any CPU = Debug|Any CPU
@@ -148,6 +152,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
+		{DF99D759-46D5-4CDB-89CB-EF56DC9728DA}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{DF99D759-46D5-4CDB-89CB-EF56DC9728DA}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{DF99D759-46D5-4CDB-89CB-EF56DC9728DA}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{DF99D759-46D5-4CDB-89CB-EF56DC9728DA}.Release|Any CPU.Build.0 = Release|Any CPU
+		{FB1FA9F6-B6B4-48B7-A522-1FAF55DFB228}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{FB1FA9F6-B6B4-48B7-A522-1FAF55DFB228}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{FB1FA9F6-B6B4-48B7-A522-1FAF55DFB228}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{FB1FA9F6-B6B4-48B7-A522-1FAF55DFB228}.Release|Any CPU.Build.0 = Release|Any CPU
 		{FAF5D8AC-B6B3-4CD4-879D-0E5F6211480F}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
 		{FAF5D8AC-B6B3-4CD4-879D-0E5F6211480F}.Debug|Any CPU.Build.0 = Debug|Any CPU
 		{FAF5D8AC-B6B3-4CD4-879D-0E5F6211480F}.Release|Any CPU.ActiveCfg = Release|Any CPU
@@ -164,10 +176,6 @@ Global
 		{2CBD2311-BA2E-4921-A000-FDDA59B74958}.Debug|Any CPU.Build.0 = Debug|Any CPU
 		{2CBD2311-BA2E-4921-A000-FDDA59B74958}.Release|Any CPU.ActiveCfg = Release|Any CPU
 		{2CBD2311-BA2E-4921-A000-FDDA59B74958}.Release|Any CPU.Build.0 = Release|Any CPU
-		{EF01E062-DBBC-47AF-AF3B-9EDEB00CFF7C}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
-		{EF01E062-DBBC-47AF-AF3B-9EDEB00CFF7C}.Debug|Any CPU.Build.0 = Debug|Any CPU
-		{EF01E062-DBBC-47AF-AF3B-9EDEB00CFF7C}.Release|Any CPU.ActiveCfg = Release|Any CPU
-		{EF01E062-DBBC-47AF-AF3B-9EDEB00CFF7C}.Release|Any CPU.Build.0 = Release|Any CPU
 		{22E2CE64-080B-4138-885F-7FA74A9159FB}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
 		{22E2CE64-080B-4138-885F-7FA74A9159FB}.Debug|Any CPU.Build.0 = Debug|Any CPU
 		{22E2CE64-080B-4138-885F-7FA74A9159FB}.Release|Any CPU.ActiveCfg = Release|Any CPU
@@ -216,6 +224,10 @@ Global
 		{185ADAFC-BFC6-413D-BC2E-97F9FB0A8AF0}.Debug|Any CPU.Build.0 = Debug|Any CPU
 		{185ADAFC-BFC6-413D-BC2E-97F9FB0A8AF0}.Release|Any CPU.ActiveCfg = Release|Any CPU
 		{185ADAFC-BFC6-413D-BC2E-97F9FB0A8AF0}.Release|Any CPU.Build.0 = Release|Any CPU
+		{9B6BC5EC-EC11-408C-BFBA-C7ABD732F5B8}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{9B6BC5EC-EC11-408C-BFBA-C7ABD732F5B8}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{9B6BC5EC-EC11-408C-BFBA-C7ABD732F5B8}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{9B6BC5EC-EC11-408C-BFBA-C7ABD732F5B8}.Release|Any CPU.Build.0 = Release|Any CPU
 	EndGlobalSection
 	GlobalSection(SolutionProperties) = preSolution
 		HideSolutionNode = FALSE
@@ -237,11 +249,12 @@ Global
 		{387CCF6C-9A26-43F6-A639-0A82E91E10D8} = {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}
+		{DF99D759-46D5-4CDB-89CB-EF56DC9728DA} = {B5339DF7-5D1D-43BA-B332-74B825E1770E}
+		{FB1FA9F6-B6B4-48B7-A522-1FAF55DFB228} = {EDE05FA8-8E73-4924-BC63-DD117127EEE1}
 		{FAF5D8AC-B6B3-4CD4-879D-0E5F6211480F} = {7F257712-D033-47FF-B439-9D4320D06599}
 		{0E92F219-1225-4DD0-8C4A-98840985D59C} = {7F257712-D033-47FF-B439-9D4320D06599}
 		{5D9764FB-827D-4DDE-84E3-3C05FD8ABC89} = {7F257712-D033-47FF-B439-9D4320D06599}
 		{2CBD2311-BA2E-4921-A000-FDDA59B74958} = {7F257712-D033-47FF-B439-9D4320D06599}
-		{EF01E062-DBBC-47AF-AF3B-9EDEB00CFF7C} = {7F257712-D033-47FF-B439-9D4320D06599}
 		{7F257712-D033-47FF-B439-9D4320D06599} = {C2DC830A-327A-42A7-807D-295216D30DBB}
 		{22E2CE64-080B-4138-885F-7FA74A9159FB} = {C2DC830A-327A-42A7-807D-295216D30DBB}
 		{4C39E872-FC37-4BFD-AE4C-3E3F0546B726} = {C2DC830A-327A-42A7-807D-295216D30DBB}
@@ -255,6 +268,7 @@ Global
 		{FF76D8A4-356B-461A-8471-BC1B83E57BBC} = {C2DC830A-327A-42A7-807D-295216D30DBB}
 		{5E4947F3-05D3-4806-B0F3-30DAC71B5986} = {C2DC830A-327A-42A7-807D-295216D30DBB}
 		{185ADAFC-BFC6-413D-BC2E-97F9FB0A8AF0} = {C2DC830A-327A-42A7-807D-295216D30DBB}
+		{9B6BC5EC-EC11-408C-BFBA-C7ABD732F5B8} = {7F257712-D033-47FF-B439-9D4320D06599}
 	EndGlobalSection
 	GlobalSection(ExtensibilityGlobals) = postSolution
 		SolutionGuid = {BCBA19D9-F868-4C6D-8061-A2B91E06E3EC}

src/Neo.Extensions/AssemblyUtility.cs

@@ -0,0 +1,25 @@
+// Copyright (C) 2015-2024 The Neo Project.
+//
+// AssemblyUtility.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 AssemblyUtility
+    {
+        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,
     }
 }