From 3f99199daf187f392146a41de952c5825a7b130d Mon Sep 17 00:00:00 2001 From: eugene-hong <58686228+eugene-doobu@users.noreply.github.com> Date: Wed, 20 Nov 2024 10:36:03 +0900 Subject: [PATCH 01/16] fix code style for namespace --- NineChronicles.Headless.Executable.sln.DotSettings | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/NineChronicles.Headless.Executable.sln.DotSettings b/NineChronicles.Headless.Executable.sln.DotSettings index e1205f7ac..b16d7bd21 100644 --- a/NineChronicles.Headless.Executable.sln.DotSettings +++ b/NineChronicles.Headless.Executable.sln.DotSettings @@ -41,8 +41,12 @@ True False 300 - True - True + False + True + True + False + True + True AI CRYSTAL GARAGE From 1931e7f504118b68ac72f3bab39d7deb3867cafc Mon Sep 17 00:00:00 2001 From: moreal Date: Wed, 20 Nov 2024 07:46:45 +0900 Subject: [PATCH 02/16] chore: remove 9crun project --- NineChronicles.Headless.Executable.sln | 22 - .../Client/GithubClient.cs | 141 ---- .../Client/HeadlessClient.cs | 48 -- .../Client/SettingsClient.cs | 44 -- .../Constants/Paths.cs | 19 - .../Constants/Planet.cs | 9 - .../Constants/PlanetEndpoints.cs | 24 - .../Constants/Secret.cs | 7 - NineChronicles.Headless.Executor/LICENSE | 661 ------------------ .../Models/AppsettingsData.cs | 11 - .../Models/HeadlessResponses.cs | 60 -- .../NineChronicles.Headless.Executor.csproj | 24 - .../PlanetManager.cs | 28 - NineChronicles.Headless.Executor/Program.cs | 219 ------ NineChronicles.Headless.Executor/README.md | 81 --- 15 files changed, 1398 deletions(-) delete mode 100644 NineChronicles.Headless.Executor/Client/GithubClient.cs delete mode 100644 NineChronicles.Headless.Executor/Client/HeadlessClient.cs delete mode 100644 NineChronicles.Headless.Executor/Client/SettingsClient.cs delete mode 100644 NineChronicles.Headless.Executor/Constants/Paths.cs delete mode 100644 NineChronicles.Headless.Executor/Constants/Planet.cs delete mode 100644 NineChronicles.Headless.Executor/Constants/PlanetEndpoints.cs delete mode 100644 NineChronicles.Headless.Executor/Constants/Secret.cs delete mode 100644 NineChronicles.Headless.Executor/LICENSE delete mode 100644 NineChronicles.Headless.Executor/Models/AppsettingsData.cs delete mode 100644 NineChronicles.Headless.Executor/Models/HeadlessResponses.cs delete mode 100644 NineChronicles.Headless.Executor/NineChronicles.Headless.Executor.csproj delete mode 100644 NineChronicles.Headless.Executor/PlanetManager.cs delete mode 100644 NineChronicles.Headless.Executor/Program.cs delete mode 100644 NineChronicles.Headless.Executor/README.md diff --git a/NineChronicles.Headless.Executable.sln b/NineChronicles.Headless.Executable.sln index 2a48c5446..b379469bc 100644 --- a/NineChronicles.Headless.Executable.sln +++ b/NineChronicles.Headless.Executable.sln @@ -52,8 +52,6 @@ Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Libplanet.Extensions.Plugge EndProject Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Lib9c.Plugin.Shared", "Lib9c\.Lib9c.Plugin.Shared\Lib9c.Plugin.Shared.csproj", "{3D32DA34-E619-429F-8421-848FF4F14417}" EndProject -Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "NineChronicles.Headless.Executor", "NineChronicles.Headless.Executor\NineChronicles.Headless.Executor.csproj", "{59AD477A-B23C-4E0B-AA26-A528B3BC5234}" -EndProject Global GlobalSection(SolutionConfigurationPlatforms) = preSolution Debug|Any CPU = Debug|Any CPU @@ -463,30 +461,10 @@ Global {3D32DA34-E619-429F-8421-848FF4F14417}.Release|x64.Build.0 = Release|Any CPU {3D32DA34-E619-429F-8421-848FF4F14417}.Release|x86.ActiveCfg = Release|Any CPU {3D32DA34-E619-429F-8421-848FF4F14417}.Release|x86.Build.0 = Release|Any CPU - {59AD477A-B23C-4E0B-AA26-A528B3BC5234}.Debug|Any CPU.ActiveCfg = Debug|Any CPU - {59AD477A-B23C-4E0B-AA26-A528B3BC5234}.Debug|Any CPU.Build.0 = Debug|Any CPU - {59AD477A-B23C-4E0B-AA26-A528B3BC5234}.Debug|x64.ActiveCfg = Debug|Any CPU - {59AD477A-B23C-4E0B-AA26-A528B3BC5234}.Debug|x64.Build.0 = Debug|Any CPU - {59AD477A-B23C-4E0B-AA26-A528B3BC5234}.Debug|x86.ActiveCfg = Debug|Any CPU - {59AD477A-B23C-4E0B-AA26-A528B3BC5234}.Debug|x86.Build.0 = Debug|Any CPU - {59AD477A-B23C-4E0B-AA26-A528B3BC5234}.DevEx|Any CPU.ActiveCfg = Debug|Any CPU - {59AD477A-B23C-4E0B-AA26-A528B3BC5234}.DevEx|Any CPU.Build.0 = Debug|Any CPU - {59AD477A-B23C-4E0B-AA26-A528B3BC5234}.DevEx|x64.ActiveCfg = Debug|Any CPU - {59AD477A-B23C-4E0B-AA26-A528B3BC5234}.DevEx|x64.Build.0 = Debug|Any CPU - {59AD477A-B23C-4E0B-AA26-A528B3BC5234}.DevEx|x86.ActiveCfg = Debug|Any CPU - {59AD477A-B23C-4E0B-AA26-A528B3BC5234}.DevEx|x86.Build.0 = Debug|Any CPU - {59AD477A-B23C-4E0B-AA26-A528B3BC5234}.Release|Any CPU.ActiveCfg = Release|Any CPU - {59AD477A-B23C-4E0B-AA26-A528B3BC5234}.Release|Any CPU.Build.0 = Release|Any CPU - {59AD477A-B23C-4E0B-AA26-A528B3BC5234}.Release|x64.ActiveCfg = Release|Any CPU - {59AD477A-B23C-4E0B-AA26-A528B3BC5234}.Release|x64.Build.0 = Release|Any CPU - {59AD477A-B23C-4E0B-AA26-A528B3BC5234}.Release|x86.ActiveCfg = Release|Any CPU - {59AD477A-B23C-4E0B-AA26-A528B3BC5234}.Release|x86.Build.0 = Release|Any CPU EndGlobalSection GlobalSection(SolutionProperties) = preSolution HideSolutionNode = FALSE EndGlobalSection - GlobalSection(NestedProjects) = preSolution - EndGlobalSection GlobalSection(ExtensibilityGlobals) = postSolution SolutionGuid = {B4A2DD82-CCC1-4D74-88FF-91BBEBB5A47F} EndGlobalSection diff --git a/NineChronicles.Headless.Executor/Client/GithubClient.cs b/NineChronicles.Headless.Executor/Client/GithubClient.cs deleted file mode 100644 index 286715862..000000000 --- a/NineChronicles.Headless.Executor/Client/GithubClient.cs +++ /dev/null @@ -1,141 +0,0 @@ -using System.IO.Compression; -using System.Runtime.InteropServices; -using System.Text.Json; -using NineChronicles.Headless.Executor.Constants; - -namespace NineChronicles.Headless.Executor.Client; - -public class GithubClient -{ - private static readonly HttpClient _client = new HttpClient(); - private static readonly string BaseDownloadUrl = - "https://github.com/planetarium/NineChronicles.Headless/releases/download/"; - private static readonly string TempDirectory = Path.Combine( - Path.GetTempPath(), - "NineChroniclesHeadless" - ); - private static readonly string GitHubReleasesApiUrl = - "https://api.github.com/repos/planetarium/NineChronicles.Headless/releases"; - - public async Task DownloadAndExtract(string version, string? os = null) - { - os ??= GetOS(); - string url = BuildDownloadUrl(version, os); - string downloadPath = await DownloadFile(url, version, os); - string extractPath = ExtractFile(downloadPath, version); - - DeleteCompressedFile(downloadPath); - - return extractPath; - } - - public async Task ListRemoteVersions(int page = 1) - { - _client.DefaultRequestHeaders.UserAgent.ParseAdd("NineChronicles.Headless"); - - string url = $"{GitHubReleasesApiUrl}?page={page}&per_page=10"; - - var response = await _client.GetAsync(url); - response.EnsureSuccessStatusCode(); - - var content = await response.Content.ReadAsStringAsync(); - var releases = JsonSerializer.Deserialize>(content); - - if (releases == null || releases.Count == 0) - { - Console.WriteLine("No remote versions found."); - return; - } - - Console.WriteLine($"Remote versions (Page {page}):"); - foreach (var release in releases) - { - Console.WriteLine(release.tag_name); - } - } - - private class GitHubRelease - { - public string tag_name { get; set; } = string.Empty; - } - - private string GetOS() - { - if (RuntimeInformation.IsOSPlatform(OSPlatform.Windows)) - return "win-x64"; - if (RuntimeInformation.IsOSPlatform(OSPlatform.Linux)) - return "linux-x64"; - if (RuntimeInformation.IsOSPlatform(OSPlatform.OSX)) - { - return RuntimeInformation.ProcessArchitecture == Architecture.Arm64 - ? "osx-arm64" - : "osx-x64"; - } - throw new NotSupportedException("Unsupported OS platform."); - } - - private string BuildDownloadUrl(string version, string os) - { - string fileExtension = GetFileExtension(os); - return $"{BaseDownloadUrl}{version}/NineChronicles.Headless-{os}.{fileExtension}"; - } - - private string GetFileExtension(string os) - { - return os.StartsWith("win") ? "zip" : "tar.xz"; - } - - private async Task DownloadFile(string url, string version, string os) - { - string fileName = Path.Combine( - TempDirectory, - $"NineChronicles.Headless-{version}-{os}.{GetFileExtension(os)}" - ); - Directory.CreateDirectory(TempDirectory); - - using (var response = await _client.GetAsync(url)) - { - response.EnsureSuccessStatusCode(); - await using var fs = new FileStream(fileName, FileMode.Create); - await response.Content.CopyToAsync(fs); - } - - return fileName; - } - - private string ExtractFile(string filePath, string version) - { - string extractFolder = GetExtractionPath(version); - Directory.CreateDirectory(extractFolder); - - if (filePath.EndsWith(".zip")) - { - ZipFile.ExtractToDirectory(filePath, extractFolder); - } - else if (filePath.EndsWith(".tar.xz")) - { - ExtractTarXZ(filePath, extractFolder); - } - - return extractFolder; - } - - private string GetExtractionPath(string version) - { - return Path.Combine(Paths.HeadlessPath, version); - } - - private void ExtractTarXZ(string filePath, string extractFolder) - { - string command = $"tar -xf {filePath} -C {extractFolder}"; - System.Diagnostics.Process.Start("/bin/bash", $"-c \"{command}\"").WaitForExit(); - } - - private void DeleteCompressedFile(string filePath) - { - if (File.Exists(filePath)) - { - File.Delete(filePath); - } - } -} diff --git a/NineChronicles.Headless.Executor/Client/HeadlessClient.cs b/NineChronicles.Headless.Executor/Client/HeadlessClient.cs deleted file mode 100644 index cbb1f7aa0..000000000 --- a/NineChronicles.Headless.Executor/Client/HeadlessClient.cs +++ /dev/null @@ -1,48 +0,0 @@ -using System.Text; -using System.Text.Json; -using System.Text.Json.Serialization; -using NineChronicles.Headless.Executor.Models; - -namespace NineChronicles.Headless.Executor.Client; - -public class HeadlessClient -{ - private readonly HttpClient _client = new HttpClient(); - public const string GetApvQuery = - @"{ - nodeStatus { - appProtocolVersion { - version - signer - signature - extra - } - } - }"; - - public async Task GetApvAsync(string headlessUrl) - { - var request = new GraphQLRequest { Query = GetApvQuery }; - var jsonRequest = JsonSerializer.Serialize(request); - var content = new StringContent(jsonRequest, Encoding.UTF8, "application/json"); - - using var httpRequest = new HttpRequestMessage(HttpMethod.Post, headlessUrl) - { - Content = content - }; - - var response = await _client.SendAsync(httpRequest); - response.EnsureSuccessStatusCode(); - - var jsonResponse = await response.Content.ReadAsStringAsync(); - - var graphQLResponse = JsonSerializer.Deserialize(jsonResponse); - - if (graphQLResponse == null) - { - throw new Exception("Failed to deserialize GraphQL response"); - } - - return graphQLResponse.Data.NodeStatus.AppProtocolVersion; - } -} diff --git a/NineChronicles.Headless.Executor/Client/SettingsClient.cs b/NineChronicles.Headless.Executor/Client/SettingsClient.cs deleted file mode 100644 index 25270627b..000000000 --- a/NineChronicles.Headless.Executor/Client/SettingsClient.cs +++ /dev/null @@ -1,44 +0,0 @@ -using NineChronicles.Headless.Executor.Constants; - -namespace NineChronicles.Headless.Executor.Client; - -public class SettingsClient -{ - private readonly HttpClient _httpClient; - - public SettingsClient() - { - _httpClient = new HttpClient - { - BaseAddress = new Uri( - "http://settings.planetariumhq.com.s3-website.us-east-2.amazonaws.com/" - ) - }; - } - - public async Task DownloadTemplateAsync(Planet planet, string destinationPath) - { - string relativeUrl = $"templates/appsettings.{planet}.tpl"; - await DownloadFileAsync(relativeUrl, destinationPath); - } - - public async Task DownloadGenesisBlockAsync(string destinationPath) - { - string relativeUrl = "genesis/genesis-block-for-single"; - await DownloadFileAsync(relativeUrl, destinationPath); - } - - private async Task DownloadFileAsync(string relativeUrl, string destinationPath) - { - var response = await _httpClient.GetAsync(relativeUrl); - response.EnsureSuccessStatusCode(); - - await using var fs = new FileStream( - destinationPath, - FileMode.Create, - FileAccess.Write, - FileShare.None - ); - await response.Content.CopyToAsync(fs); - } -} diff --git a/NineChronicles.Headless.Executor/Constants/Paths.cs b/NineChronicles.Headless.Executor/Constants/Paths.cs deleted file mode 100644 index 4f84e593d..000000000 --- a/NineChronicles.Headless.Executor/Constants/Paths.cs +++ /dev/null @@ -1,19 +0,0 @@ -namespace NineChronicles.Headless.Executor.Constants; - -public class Paths -{ - public static readonly string BasePath = Path.Combine( - Environment.GetFolderPath(Environment.SpecialFolder.UserProfile), - ".planetarium", - "headless" - ); - public static readonly string HeadlessPath = Path.Combine(BasePath, "versions"); - - public static readonly string AppsettingsPath = Path.Combine(BasePath, "appsettings"); - - public static readonly string AppsettingsTplPath = Path.Combine(BasePath, "templates"); - - public static readonly string StorePath = Path.Combine(BasePath, "store"); - - public static readonly string GenesisBlockPath = Path.Combine(BasePath, "genesis-block"); -} diff --git a/NineChronicles.Headless.Executor/Constants/Planet.cs b/NineChronicles.Headless.Executor/Constants/Planet.cs deleted file mode 100644 index ef2714f0d..000000000 --- a/NineChronicles.Headless.Executor/Constants/Planet.cs +++ /dev/null @@ -1,9 +0,0 @@ -namespace NineChronicles.Headless.Executor.Constants; - -public enum Planet -{ - MainnetOdin, - MainnetHeimdall, - Single, - Custom -} diff --git a/NineChronicles.Headless.Executor/Constants/PlanetEndpoints.cs b/NineChronicles.Headless.Executor/Constants/PlanetEndpoints.cs deleted file mode 100644 index 19bd9cfe5..000000000 --- a/NineChronicles.Headless.Executor/Constants/PlanetEndpoints.cs +++ /dev/null @@ -1,24 +0,0 @@ -namespace NineChronicles.Headless.Executor.Constants; - -public static class PlanetEndpoints -{ - public static readonly IReadOnlyDictionary GraphQLEndpoints = new Dictionary< - Planet, - string - > - { - { Planet.MainnetOdin, "https://9c-main-rpc-1.nine-chronicles.com/graphql" }, - { Planet.MainnetHeimdall, "https://heimdall-rpc-1.nine-chronicles.com/graphql" } - }; - - public static string GetGraphQLEndpoint(Planet planet) - { - if (GraphQLEndpoints.TryGetValue(planet, out string endpoint)) - { - return endpoint; - } - throw new Exception( - $"GraphQL endpoint not defined for planet: {planet}. Please ensure the planet is correctly mapped in {nameof(GraphQLEndpoints)}." - ); - } -} diff --git a/NineChronicles.Headless.Executor/Constants/Secret.cs b/NineChronicles.Headless.Executor/Constants/Secret.cs deleted file mode 100644 index f5c6e79e3..000000000 --- a/NineChronicles.Headless.Executor/Constants/Secret.cs +++ /dev/null @@ -1,7 +0,0 @@ -namespace NineChronicles.Headless.Executor.Constants; - -public class Secret -{ - public static readonly string PrivateKeyForSingleNode = - "9fe5f7c309495d284ca36b948fdeca0e65b21a019e2f8a03efd849df88fab102"; -} diff --git a/NineChronicles.Headless.Executor/LICENSE b/NineChronicles.Headless.Executor/LICENSE deleted file mode 100644 index 6bb533977..000000000 --- a/NineChronicles.Headless.Executor/LICENSE +++ /dev/null @@ -1,661 +0,0 @@ -GNU AFFERO GENERAL PUBLIC LICENSE - Version 3, 19 November 2007 - -Copyright (C) 2007 Free Software Foundation, Inc. -Everyone is permitted to copy and distribute verbatim copies -of this license document, but changing it is not allowed. - - Preamble - -The GNU Affero General Public License is a free, copyleft license for -software and other kinds of works, specifically designed to ensure -cooperation with the community in the case of network server software. - -The licenses for most software and other practical works are designed -to take away your freedom to share and change the works. By contrast, -our General Public Licenses are intended to guarantee your freedom to -share and change all versions of a program--to make sure it remains free -software for all its users. - -When we speak of free software, we are referring to freedom, not -price. Our General Public Licenses are designed to make sure that you -have the freedom to distribute copies of free software (and charge for -them if you wish), that you receive source code or can get it if you -want it, that you can change the software or use pieces of it in new -free programs, and that you know you can do these things. - -Developers that use our General Public Licenses protect your rights -with two steps: (1) assert copyright on the software, and (2) offer -you this License which gives you legal permission to copy, distribute -and/or modify the software. - -A secondary benefit of defending all users' freedom is that -improvements made in alternate versions of the program, if they -receive widespread use, become available for other developers to -incorporate. Many developers of free software are heartened and -encouraged by the resulting cooperation. However, in the case of -software used on network servers, this result may fail to come about. -The GNU General Public License permits making a modified version and -letting the public access it on a server without ever releasing its -source code to the public. - -The GNU Affero General Public License is designed specifically to -ensure that, in such cases, the modified source code becomes available -to the community. It requires the operator of a network server to -provide the source code of the modified version running there to the -users of that server. Therefore, public use of a modified version, on -a publicly accessible server, gives the public access to the source -code of the modified version. - -An older license, called the Affero General Public License and -published by Affero, was designed to accomplish similar goals. This is -a different license, not a version of the Affero GPL, but Affero has -released a new version of the Affero GPL which permits relicensing under -this license. - -The precise terms and conditions for copying, distribution and -modification follow. - - TERMS AND CONDITIONS - -0. Definitions. - -"This License" refers to version 3 of the GNU Affero General Public License. - -"Copyright" also means copyright-like laws that apply to other kinds of -works, such as semiconductor masks. - -"The Program" refers to any copyrightable work licensed under this -License. Each licensee is addressed as "you". "Licensees" and -"recipients" may be individuals or organizations. - -To "modify" a work means to copy from or adapt all or part of the work -in a fashion requiring copyright permission, other than the making of an -exact copy. The resulting work is called a "modified version" of the -earlier work or a work "based on" the earlier work. - -A "covered work" means either the unmodified Program or a work based -on the Program. - -To "propagate" a work means to do anything with it that, without -permission, would make you directly or secondarily liable for -infringement under applicable copyright law, except executing it on a -computer or modifying a private copy. Propagation includes copying, -distribution (with or without modification), making available to the -public, and in some countries other activities as well. - -To "convey" a work means any kind of propagation that enables other -parties to make or receive copies. Mere interaction with a user through -a computer network, with no transfer of a copy, is not conveying. - -An interactive user interface displays "Appropriate Legal Notices" -to the extent that it includes a convenient and prominently visible -feature that (1) displays an appropriate copyright notice, and (2) -tells the user that there is no warranty for the work (except to the -extent that warranties are provided), that licensees may convey the -work under this License, and how to view a copy of this License. If -the interface presents a list of user commands or options, such as a -menu, a prominent item in the list meets this criterion. - -1. Source Code. - -The "source code" for a work means the preferred form of the work -for making modifications to it. "Object code" means any non-source -form of a work. - -A "Standard Interface" means an interface that either is an official -standard defined by a recognized standards body, or, in the case of -interfaces specified for a particular programming language, one that -is widely used among developers working in that language. - -The "System Libraries" of an executable work include anything, other -than the work as a whole, that (a) is included in the normal form of -packaging a Major Component, but which is not part of that Major -Component, and (b) serves only to enable use of the work with that -Major Component, or to implement a Standard Interface for which an -implementation is available to the public in source code form. A -"Major Component", in this context, means a major essential component -(kernel, window system, and so on) of the specific operating system -(if any) on which the executable work runs, or a compiler used to -produce the work, or an object code interpreter used to run it. - -The "Corresponding Source" for a work in object code form means all -the source code needed to generate, install, and (for an executable -work) run the object code and to modify the work, including scripts to -control those activities. However, it does not include the work's -System Libraries, or general-purpose tools or generally available free -programs which are used unmodified in performing those activities but -which are not part of the work. For example, Corresponding Source -includes interface definition files associated with source files for -the work, and the source code for shared libraries and dynamically -linked subprograms that the work is specifically designed to require, -such as by intimate data communication or control flow between those -subprograms and other parts of the work. - -The Corresponding Source need not include anything that users -can regenerate automatically from other parts of the Corresponding -Source. - -The Corresponding Source for a work in source code form is that -same work. - -2. Basic Permissions. - -All rights granted under this License are granted for the term of -copyright on the Program, and are irrevocable provided the stated -conditions are met. This License explicitly affirms your unlimited -permission to run the unmodified Program. The output from running a -covered work is covered by this License only if the output, given its -content, constitutes a covered work. This License acknowledges your -rights of fair use or other equivalent, as provided by copyright law. - -You may make, run and propagate covered works that you do not -convey, without conditions so long as your license otherwise remains -in force. You may convey covered works to others for the sole purpose -of having them make modifications exclusively for you, or provide you -with facilities for running those works, provided that you comply with -the terms of this License in conveying all material for which you do -not control copyright. Those thus making or running the covered works -for you must do so exclusively on your behalf, under your direction -and control, on terms that prohibit them from making any copies of -your copyrighted material outside their relationship with you. - -Conveying under any other circumstances is permitted solely under -the conditions stated below. Sublicensing is not allowed; section 10 -makes it unnecessary. - -3. Protecting Users' Legal Rights From Anti-Circumvention Law. - -No covered work shall be deemed part of an effective technological -measure under any applicable law fulfilling obligations under article -11 of the WIPO copyright treaty adopted on 20 December 1996, or -similar laws prohibiting or restricting circumvention of such -measures. - -When you convey a covered work, you waive any legal power to forbid -circumvention of technological measures to the extent such circumvention -is effected by exercising rights under this License with respect to -the covered work, and you disclaim any intention to limit operation or -modification of the work as a means of enforcing, against the work's -users, your or third parties' legal rights to forbid circumvention of -technological measures. - -4. Conveying Verbatim Copies. - -You may convey verbatim copies of the Program's source code as you -receive it, in any medium, provided that you conspicuously and -appropriately publish on each copy an appropriate copyright notice; -keep intact all notices stating that this License and any -non-permissive terms added in accord with section 7 apply to the code; -keep intact all notices of the absence of any warranty; and give all -recipients a copy of this License along with the Program. - -You may charge any price or no price for each copy that you convey, -and you may offer support or warranty protection for a fee. - -5. Conveying Modified Source Versions. - -You may convey a work based on the Program, or the modifications to -produce it from the Program, in the form of source code under the -terms of section 4, provided that you also meet all of these conditions: - -a) The work must carry prominent notices stating that you modified -it, and giving a relevant date. - -b) The work must carry prominent notices stating that it is -released under this License and any conditions added under section -7. This requirement modifies the requirement in section 4 to -"keep intact all notices". - -c) You must license the entire work, as a whole, under this -License to anyone who comes into possession of a copy. This -License will therefore apply, along with any applicable section 7 -additional terms, to the whole of the work, and all its parts, -regardless of how they are packaged. This License gives no -permission to license the work in any other way, but it does not -invalidate such permission if you have separately received it. - -d) If the work has interactive user interfaces, each must display -Appropriate Legal Notices; however, if the Program has interactive -interfaces that do not display Appropriate Legal Notices, your -work need not make them do so. - -A compilation of a covered work with other separate and independent -works, which are not by their nature extensions of the covered work, -and which are not combined with it such as to form a larger program, -in or on a volume of a storage or distribution medium, is called an -"aggregate" if the compilation and its resulting copyright are not -used to limit the access or legal rights of the compilation's users -beyond what the individual works permit. Inclusion of a covered work -in an aggregate does not cause this License to apply to the other -parts of the aggregate. - -6. Conveying Non-Source Forms. - -You may convey a covered work in object code form under the terms -of sections 4 and 5, provided that you also convey the -machine-readable Corresponding Source under the terms of this License, -in one of these ways: - -a) Convey the object code in, or embodied in, a physical product -(including a physical distribution medium), accompanied by the -Corresponding Source fixed on a durable physical medium -customarily used for software interchange. - -b) Convey the object code in, or embodied in, a physical product -(including a physical distribution medium), accompanied by a -written offer, valid for at least three years and valid for as -long as you offer spare parts or customer support for that product -model, to give anyone who possesses the object code either (1) a -copy of the Corresponding Source for all the software in the -product that is covered by this License, on a durable physical -medium customarily used for software interchange, for a price no -more than your reasonable cost of physically performing this -conveying of source, or (2) access to copy the -Corresponding Source from a network server at no charge. - -c) Convey individual copies of the object code with a copy of the -written offer to provide the Corresponding Source. This -alternative is allowed only occasionally and noncommercially, and -only if you received the object code with such an offer, in accord -with subsection 6b. - -d) Convey the object code by offering access from a designated -place (gratis or for a charge), and offer equivalent access to the -Corresponding Source in the same way through the same place at no -further charge. You need not require recipients to copy the -Corresponding Source along with the object code. If the place to -copy the object code is a network server, the Corresponding Source -may be on a different server (operated by you or a third party) -that supports equivalent copying facilities, provided you maintain -clear directions next to the object code saying where to find the -Corresponding Source. Regardless of what server hosts the -Corresponding Source, you remain obligated to ensure that it is -available for as long as needed to satisfy these requirements. - -e) Convey the object code using peer-to-peer transmission, provided -you inform other peers where the object code and Corresponding -Source of the work are being offered to the general public at no -charge under subsection 6d. - -A separable portion of the object code, whose source code is excluded -from the Corresponding Source as a System Library, need not be -included in conveying the object code work. - -A "User Product" is either (1) a "consumer product", which means any -tangible personal property which is normally used for personal, family, -or household purposes, or (2) anything designed or sold for incorporation -into a dwelling. In determining whether a product is a consumer product, -doubtful cases shall be resolved in favor of coverage. For a particular -product received by a particular user, "normally used" refers to a -typical or common use of that class of product, regardless of the status -of the particular user or of the way in which the particular user -actually uses, or expects or is expected to use, the product. A product -is a consumer product regardless of whether the product has substantial -commercial, industrial or non-consumer uses, unless such uses represent -the only significant mode of use of the product. - -"Installation Information" for a User Product means any methods, -procedures, authorization keys, or other information required to install -and execute modified versions of a covered work in that User Product from -a modified version of its Corresponding Source. The information must -suffice to ensure that the continued functioning of the modified object -code is in no case prevented or interfered with solely because -modification has been made. - -If you convey an object code work under this section in, or with, or -specifically for use in, a User Product, and the conveying occurs as -part of a transaction in which the right of possession and use of the -User Product is transferred to the recipient in perpetuity or for a -fixed term (regardless of how the transaction is characterized), the -Corresponding Source conveyed under this section must be accompanied -by the Installation Information. But this requirement does not apply -if neither you nor any third party retains the ability to install -modified object code on the User Product (for example, the work has -been installed in ROM). - -The requirement to provide Installation Information does not include a -requirement to continue to provide support service, warranty, or updates -for a work that has been modified or installed by the recipient, or for -the User Product in which it has been modified or installed. Access to a -network may be denied when the modification itself materially and -adversely affects the operation of the network or violates the rules and -protocols for communication across the network. - -Corresponding Source conveyed, and Installation Information provided, -in accord with this section must be in a format that is publicly -documented (and with an implementation available to the public in -source code form), and must require no special password or key for -unpacking, reading or copying. - -7. Additional Terms. - -"Additional permissions" are terms that supplement the terms of this -License by making exceptions from one or more of its conditions. -Additional permissions that are applicable to the entire Program shall -be treated as though they were included in this License, to the extent -that they are valid under applicable law. If additional permissions -apply only to part of the Program, that part may be used separately -under those permissions, but the entire Program remains governed by -this License without regard to the additional permissions. - -When you convey a copy of a covered work, you may at your option -remove any additional permissions from that copy, or from any part of -it. (Additional permissions may be written to require their own -removal in certain cases when you modify the work.) You may place -additional permissions on material, added by you to a covered work, -for which you have or can give appropriate copyright permission. - -Notwithstanding any other provision of this License, for material you -add to a covered work, you may (if authorized by the copyright holders of -that material) supplement the terms of this License with terms: - -a) Disclaiming warranty or limiting liability differently from the -terms of sections 15 and 16 of this License; or - -b) Requiring preservation of specified reasonable legal notices or -author attributions in that material or in the Appropriate Legal -Notices displayed by works containing it; or - -c) Prohibiting misrepresentation of the origin of that material, or -requiring that modified versions of such material be marked in -reasonable ways as different from the original version; or - -d) Limiting the use for publicity purposes of names of licensors or -authors of the material; or - -e) Declining to grant rights under trademark law for use of some -trade names, trademarks, or service marks; or - -f) Requiring indemnification of licensors and authors of that -material by anyone who conveys the material (or modified versions of -it) with contractual assumptions of liability to the recipient, for -any liability that these contractual assumptions directly impose on -those licensors and authors. - -All other non-permissive additional terms are considered "further -restrictions" within the meaning of section 10. If the Program as you -received it, or any part of it, contains a notice stating that it is -governed by this License along with a term that is a further -restriction, you may remove that term. If a license document contains -a further restriction but permits relicensing or conveying under this -License, you may add to a covered work material governed by the terms -of that license document, provided that the further restriction does -not survive such relicensing or conveying. - -If you add terms to a covered work in accord with this section, you -must place, in the relevant source files, a statement of the -additional terms that apply to those files, or a notice indicating -where to find the applicable terms. - -Additional terms, permissive or non-permissive, may be stated in the -form of a separately written license, or stated as exceptions; -the above requirements apply either way. - -8. Termination. - -You may not propagate or modify a covered work except as expressly -provided under this License. Any attempt otherwise to propagate or -modify it is void, and will automatically terminate your rights under -this License (including any patent licenses granted under the third -paragraph of section 11). - -However, if you cease all violation of this License, then your -license from a particular copyright holder is reinstated (a) -provisionally, unless and until the copyright holder explicitly and -finally terminates your license, and (b) permanently, if the copyright -holder fails to notify you of the violation by some reasonable means -prior to 60 days after the cessation. - -Moreover, your license from a particular copyright holder is -reinstated permanently if the copyright holder notifies you of the -violation by some reasonable means, this is the first time you have -received notice of violation of this License (for any work) from that -copyright holder, and you cure the violation prior to 30 days after -your receipt of the notice. - -Termination of your rights under this section does not terminate the -licenses of parties who have received copies or rights from you under -this License. If your rights have been terminated and not permanently -reinstated, you do not qualify to receive new licenses for the same -material under section 10. - -9. Acceptance Not Required for Having Copies. - -You are not required to accept this License in order to receive or -run a copy of the Program. Ancillary propagation of a covered work -occurring solely as a consequence of using peer-to-peer transmission -to receive a copy likewise does not require acceptance. However, -nothing other than this License grants you permission to propagate or -modify any covered work. These actions infringe copyright if you do -not accept this License. Therefore, by modifying or propagating a -covered work, you indicate your acceptance of this License to do so. - -10. Automatic Licensing of Downstream Recipients. - -Each time you convey a covered work, the recipient automatically -receives a license from the original licensors, to run, modify and -propagate that work, subject to this License. You are not responsible -for enforcing compliance by third parties with this License. - -An "entity transaction" is a transaction transferring control of an -organization, or substantially all assets of one, or subdividing an -organization, or merging organizations. If propagation of a covered -work results from an entity transaction, each party to that -transaction who receives a copy of the work also receives whatever -licenses to the work the party's predecessor in interest had or could -give under the previous paragraph, plus a right to possession of the -Corresponding Source of the work from the predecessor in interest, if -the predecessor has it or can get it with reasonable efforts. - -You may not impose any further restrictions on the exercise of the -rights granted or affirmed under this License. For example, you may -not impose a license fee, royalty, or other charge for exercise of -rights granted under this License, and you may not initiate litigation -(including a cross-claim or counterclaim in a lawsuit) alleging that -any patent claim is infringed by making, using, selling, offering for -sale, or importing the Program or any portion of it. - -11. Patents. - -A "contributor" is a copyright holder who authorizes use under this -License of the Program or a work on which the Program is based. The -work thus licensed is called the contributor's "contributor version". - -A contributor's "essential patent claims" are all patent claims -owned or controlled by the contributor, whether already acquired or -hereafter acquired, that would be infringed by some manner, permitted -by this License, of making, using, or selling its contributor version, -but do not include claims that would be infringed only as a -consequence of further modification of the contributor version. For -purposes of this definition, "control" includes the right to grant -patent sublicenses in a manner consistent with the requirements of -this License. - -Each contributor grants you a non-exclusive, worldwide, royalty-free -patent license under the contributor's essential patent claims, to -make, use, sell, offer for sale, import and otherwise run, modify and -propagate the contents of its contributor version. - -In the following three paragraphs, a "patent license" is any express -agreement or commitment, however denominated, not to enforce a patent -(such as an express permission to practice a patent or covenant not to -sue for patent infringement). To "grant" such a patent license to a -party means to make such an agreement or commitment not to enforce a -patent against the party. - -If you convey a covered work, knowingly relying on a patent license, -and the Corresponding Source of the work is not available for anyone -to copy, free of charge and under the terms of this License, through a -publicly available network server or other readily accessible means, -then you must either (1) cause the Corresponding Source to be so -available, or (2) arrange to deprive yourself of the benefit of the -patent license for this particular work, or (3) arrange, in a manner -consistent with the requirements of this License, to extend the patent -license to downstream recipients. "Knowingly relying" means you have -actual knowledge that, but for the patent license, your conveying the -covered work in a country, or your recipient's use of the covered work -in a country, would infringe one or more identifiable patents in that -country that you have reason to believe are valid. - -If, pursuant to or in connection with a single transaction or -arrangement, you convey, or propagate by procuring conveyance of, a -covered work, and grant a patent license to some of the parties -receiving the covered work authorizing them to use, propagate, modify -or convey a specific copy of the covered work, then the patent license -you grant is automatically extended to all recipients of the covered -work and works based on it. - -A patent license is "discriminatory" if it does not include within -the scope of its coverage, prohibits the exercise of, or is -conditioned on the non-exercise of one or more of the rights that are -specifically granted under this License. You may not convey a covered -work if you are a party to an arrangement with a third party that is -in the business of distributing software, under which you make payment -to the third party based on the extent of your activity of conveying -the work, and under which the third party grants, to any of the -parties who would receive the covered work from you, a discriminatory -patent license (a) in connection with copies of the covered work -conveyed by you (or copies made from those copies), or (b) primarily -for and in connection with specific products or compilations that -contain the covered work, unless you entered into that arrangement, -or that patent license was granted, prior to 28 March 2007. - -Nothing in this License shall be construed as excluding or limiting -any implied license or other defenses to infringement that may -otherwise be available to you under applicable patent law. - -12. No Surrender of Others' Freedom. - -If conditions are imposed on you (whether by court order, agreement or -otherwise) that contradict the conditions of this License, they do not -excuse you from the conditions of this License. If you cannot convey a -covered work so as to satisfy simultaneously your obligations under this -License and any other pertinent obligations, then as a consequence you may -not convey it at all. For example, if you agree to terms that obligate you -to collect a royalty for further conveying from those to whom you convey -the Program, the only way you could satisfy both those terms and this -License would be to refrain entirely from conveying the Program. - -13. Remote Network Interaction; Use with the GNU General Public License. - -Notwithstanding any other provision of this License, if you modify the -Program, your modified version must prominently offer all users -interacting with it remotely through a computer network (if your version -supports such interaction) an opportunity to receive the Corresponding -Source of your version by providing access to the Corresponding Source -from a network server at no charge, through some standard or customary -means of facilitating copying of software. This Corresponding Source -shall include the Corresponding Source for any work covered by version 3 -of the GNU General Public License that is incorporated pursuant to the -following paragraph. - -Notwithstanding any other provision of this License, you have -permission to link or combine any covered work with a work licensed -under version 3 of the GNU General Public License into a single -combined work, and to convey the resulting work. The terms of this -License will continue to apply to the part which is the covered work, -but the work with which it is combined will remain governed by version -3 of the GNU General Public License. - -14. Revised Versions of this License. - -The Free Software Foundation may publish revised and/or new versions of -the GNU Affero General Public License from time to time. Such new versions -will be similar in spirit to the present version, but may differ in detail to -address new problems or concerns. - -Each version is given a distinguishing version number. If the -Program specifies that a certain numbered version of the GNU Affero General -Public License "or any later version" applies to it, you have the -option of following the terms and conditions either of that numbered -version or of any later version published by the Free Software -Foundation. If the Program does not specify a version number of the -GNU Affero General Public License, you may choose any version ever published -by the Free Software Foundation. - -If the Program specifies that a proxy can decide which future -versions of the GNU Affero General Public License can be used, that proxy's -public statement of acceptance of a version permanently authorizes you -to choose that version for the Program. - -Later license versions may give you additional or different -permissions. However, no additional obligations are imposed on any -author or copyright holder as a result of your choosing to follow a -later version. - -15. Disclaimer of Warranty. - -THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY -APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT -HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY -OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, -THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR -PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM -IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF -ALL NECESSARY SERVICING, REPAIR OR CORRECTION. - -16. Limitation of Liability. - -IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING -WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS -THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY -GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE -USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF -DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD -PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), -EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF -SUCH DAMAGES. - -17. Interpretation of Sections 15 and 16. - -If the disclaimer of warranty and limitation of liability provided -above cannot be given local legal effect according to their terms, -reviewing courts shall apply local law that most closely approximates -an absolute waiver of all civil liability in connection with the -Program, unless a warranty or assumption of liability accompanies a -copy of the Program in return for a fee. - - END OF TERMS AND CONDITIONS - -How to Apply These Terms to Your New Programs - -If you develop a new program, and you want it to be of the greatest -possible use to the public, the best way to achieve this is to make it -free software which everyone can redistribute and change under these terms. - -To do so, attach the following notices to the program. It is safest -to attach them to the start of each source file to most effectively -state the exclusion of warranty; and each file should have at least -the "copyright" line and a pointer to where the full notice is found. - - -Copyright (C) - -This program is free software: you can redistribute it and/or modify -it under the terms of the GNU Affero General Public License as published -by the Free Software Foundation, either version 3 of the License, or -(at your option) any later version. - -This program is distributed in the hope that it will be useful, -but WITHOUT ANY WARRANTY; without even the implied warranty of -MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -GNU Affero General Public License for more details. - -You should have received a copy of the GNU Affero General Public License -along with this program. If not, see . - -Also add information on how to contact you by electronic and paper mail. - -If your software can interact with users remotely through a computer -network, you should also make sure that it provides a way for users to -get its source. For example, if your program is a web application, its -interface could display a "Source" link that leads users to an archive -of the code. There are many ways you could offer source, and different -solutions will be better for different programs; see section 13 for the -specific requirements. - -You should also get your employer (if you work as a programmer) or school, -if any, to sign a "copyright disclaimer" for the program, if necessary. -For more information on this, and how to apply and follow the GNU AGPL, see -. diff --git a/NineChronicles.Headless.Executor/Models/AppsettingsData.cs b/NineChronicles.Headless.Executor/Models/AppsettingsData.cs deleted file mode 100644 index d70409bfb..000000000 --- a/NineChronicles.Headless.Executor/Models/AppsettingsData.cs +++ /dev/null @@ -1,11 +0,0 @@ -namespace NineChronicles.Headless.Executor.Models; - -public class AppSettingsData -{ - public string Apv { get; set; } - public string GenesisBlockPath { get; set; } - public string StorePath { get; set; } - public string MinerPrivateKeyString { get; set; } - public string ConsensusPrivateKeyString { get; set; } - public string ConsensusSeedPublicKey { get; set; } -} diff --git a/NineChronicles.Headless.Executor/Models/HeadlessResponses.cs b/NineChronicles.Headless.Executor/Models/HeadlessResponses.cs deleted file mode 100644 index 08b1f1c96..000000000 --- a/NineChronicles.Headless.Executor/Models/HeadlessResponses.cs +++ /dev/null @@ -1,60 +0,0 @@ -using System.Text; -using System.Text.Json.Serialization; - -namespace NineChronicles.Headless.Executor.Models; - -public class GraphQLRequest -{ - [JsonPropertyName("query")] - public string Query { get; set; } -} - -public class AppProtocolVersion -{ - [JsonPropertyName("version")] - public int Version { get; set; } - - [JsonPropertyName("signer")] - public string Signer { get; set; } - - [JsonPropertyName("signature")] - public string Signature { get; set; } - - [JsonPropertyName("extra")] - public string Extra { get; set; } - - public string ToToken() - { - byte[] signatureBytes = Convert.FromHexString(Signature); - string sig = Convert.ToBase64String(signatureBytes).Replace('/', '.'); - - var prefix = $"{Version}/{Signer.Remove(0, 2)}/{sig}"; - - if (Extra is not null) - { - byte[] extraBytes = Convert.FromHexString(Extra); - string extra = Convert.ToBase64String(extraBytes).Replace('/', '.'); - return $"{prefix}/{extra}"; - } - - return prefix; - } -} - -public class NodeStatus -{ - [JsonPropertyName("appProtocolVersion")] - public AppProtocolVersion AppProtocolVersion { get; set; } -} - -public class Data -{ - [JsonPropertyName("nodeStatus")] - public NodeStatus NodeStatus { get; set; } -} - -public class GraphQLResponse -{ - [JsonPropertyName("data")] - public Data Data { get; set; } -} diff --git a/NineChronicles.Headless.Executor/NineChronicles.Headless.Executor.csproj b/NineChronicles.Headless.Executor/NineChronicles.Headless.Executor.csproj deleted file mode 100644 index 8a3eb9822..000000000 --- a/NineChronicles.Headless.Executor/NineChronicles.Headless.Executor.csproj +++ /dev/null @@ -1,24 +0,0 @@ - - - - Exe - net6.0 - enable - enable - 0.1.2 - true - 9crun - ./nupkg - - - - - - - - - - - - - diff --git a/NineChronicles.Headless.Executor/PlanetManager.cs b/NineChronicles.Headless.Executor/PlanetManager.cs deleted file mode 100644 index 4774fbdda..000000000 --- a/NineChronicles.Headless.Executor/PlanetManager.cs +++ /dev/null @@ -1,28 +0,0 @@ -using NineChronicles.Headless.Executor.Constants; - -namespace NineChronicles.Headless.Executor; - -public class PlanetManager -{ - public void ListLocalVersions() - { - if (!Directory.Exists(Paths.HeadlessPath)) - { - Console.WriteLine($"Headless folder not found: {Paths.HeadlessPath}"); - return; - } - - var directories = Directory.GetDirectories(Paths.HeadlessPath); - if (directories.Length == 0) - { - Console.WriteLine("No local versions found."); - return; - } - - Console.WriteLine("Installed versions:"); - foreach (var dir in directories) - { - Console.WriteLine(Path.GetFileName(dir)); - } - } -} diff --git a/NineChronicles.Headless.Executor/Program.cs b/NineChronicles.Headless.Executor/Program.cs deleted file mode 100644 index 7526fcaa3..000000000 --- a/NineChronicles.Headless.Executor/Program.cs +++ /dev/null @@ -1,219 +0,0 @@ -using System.Diagnostics; -using System.Text.Json; -using System.Text.Json.Nodes; -using Cocona; -using Cocona.Docs; -using Libplanet.Common; -using Libplanet.Crypto; -using NineChronicles.Headless.Executor.Client; -using NineChronicles.Headless.Executor.Constants; -using NineChronicles.Headless.Executor.Models; - -namespace NineChronicles.Headless.Executor; - -[HasSubCommands(typeof(DocumentCommand), "docs")] -public class Program -{ - static async Task Main(string[] args) - { - await CoconaLiteApp.RunAsync(args); - } - - [Command(Description = "Install a headless")] - public async Task Install( - [Argument(Description = "The version of NineChronicles.Headless to download")] - string version, - [Option( - Description = "The OS platform to download for (optional, will auto-detect if not provided)" - )] - string? os = null - ) - { - var client = new GithubClient(); - Console.WriteLine($"Downloading version {version} of NineChronicles Headless..."); - await client.DownloadAndExtract(version, os); - Console.WriteLine("Installation complete!"); - } - - [Command(Description = "List installed headless versions")] - public async Task Versions( - [Option(Description = "List remote versions available for download")] bool remote = false, - [Option(Description = "Page number for remote version pagination")] int page = 1 - ) - { - if (remote) - { - var client = new GithubClient(); - await client.ListRemoteVersions(page); - } - else - { - var planetManager = new PlanetManager(); - planetManager.ListLocalVersions(); - } - } - - [Command(Description = "Run Headless")] - public async Task Run(string version, Planet planet) - { - string extractedPath = Path.Combine(Paths.HeadlessPath, version); - string headlessDllPath = Path.Combine( - extractedPath, - "NineChronicles.Headless.Executable.dll" - ); - if (!File.Exists(headlessDllPath)) - { - throw new FileNotFoundException($"Headless DLL not found in path {headlessDllPath}"); - } - - var appSettingsData = new AppSettingsData(); - string storePath = Path.Combine(Paths.StorePath, version, planet.ToString()); - var settingsClient = new SettingsClient(); - - switch (planet) - { - case Planet.MainnetOdin: - case Planet.MainnetHeimdall: - var headlessClient = new HeadlessClient(); - var apv = await headlessClient.GetApvAsync( - PlanetEndpoints.GetGraphQLEndpoint(planet) - ); - - appSettingsData = new AppSettingsData - { - Apv = apv.ToToken(), - StorePath = storePath, - }; - - if (!Directory.Exists(storePath)) - { - Console.WriteLine($"Warning: Store path does not exist: {storePath}"); - Console.WriteLine( - $"It is recommended to download and extract the snapshot to {storePath} to avoid starting synchronization from block 0, which can take a long time." - ); - } - await CreateAppSettingsFile(planet, settingsClient, appSettingsData); - break; - case Planet.Single: - var pkey = new PrivateKey(Secret.PrivateKeyForSingleNode); - string genesisBlockPath = Path.Combine( - Paths.GenesisBlockPath, - "genesis-block-for-single" - ); - - if (!File.Exists(genesisBlockPath)) - { - Directory.CreateDirectory(Paths.GenesisBlockPath); - await settingsClient.DownloadGenesisBlockAsync(genesisBlockPath); - } - - appSettingsData = new AppSettingsData - { - Apv = "1/b4179Ad0d7565A6EcFA70d2a0f727461039e0159/MEUCIQDvIIp8IKCpjKojE8LzgYZzeRg9fUPl.sWHrowzHhmrxgIgBhTkSRc8BHXZwwIAwBQN8J3wGlAbOD7FRyp8bA6OH6Y=", - StorePath = storePath, - GenesisBlockPath = genesisBlockPath, - MinerPrivateKeyString = ByteUtil.Hex(pkey.ToByteArray()), - ConsensusPrivateKeyString = ByteUtil.Hex(pkey.ToByteArray()), - ConsensusSeedPublicKey = ByteUtil.Hex(pkey.PublicKey.Format(true)) - }; - await CreateAppSettingsFile(planet, settingsClient, appSettingsData); - break; - } - - var appsettingsPath = Path.Combine(Paths.AppsettingsPath, $"appsettings.{planet}.json"); - - var startInfo = new ProcessStartInfo - { - FileName = "dotnet", - Arguments = $"{headlessDllPath} --config {appsettingsPath}", - RedirectStandardOutput = true, - RedirectStandardError = true, - UseShellExecute = false, - CreateNoWindow = true, - WorkingDirectory = extractedPath - }; - - using (var process = new Process { StartInfo = startInfo }) - { - process.OutputDataReceived += (sender, args) => - { - if (!string.IsNullOrEmpty(args.Data)) - { - Console.WriteLine(args.Data); - } - }; - - process.ErrorDataReceived += (sender, args) => - { - if (!string.IsNullOrEmpty(args.Data)) - { - Console.Error.WriteLine(args.Data); - } - }; - - process.Start(); - - process.BeginOutputReadLine(); - process.BeginErrorReadLine(); - - process.WaitForExit(); - } - } - - private async Task CreateAppSettingsFile( - Planet planet, - SettingsClient client, - AppSettingsData data - ) - { - string templatePath = Path.Combine(Paths.AppsettingsTplPath, $"appsettings.{planet}.tpl"); - - if (!File.Exists(templatePath)) - { - Directory.CreateDirectory(Paths.AppsettingsTplPath); - await client.DownloadTemplateAsync(planet, templatePath); - } - - var appsettingsPath = Path.Combine(Paths.AppsettingsPath, $"appsettings.{planet}.json"); - string result; - - if (!File.Exists(appsettingsPath)) - { - var templateContent = File.ReadAllText(templatePath); - if (Environment.OSVersion.Platform == PlatformID.Win32NT) - { - templateContent = templateContent - .Replace("${Apv}", data.Apv) - .Replace("${GenesisBlockPath}", data.GenesisBlockPath.Replace("\\", "\\\\")) - .Replace("${StorePath}", data.StorePath.Replace("\\", "\\\\")) - .Replace("${MinerPrivateKeyString}", data.MinerPrivateKeyString) - .Replace("${ConsensusPrivateKeyString}", data.ConsensusPrivateKeyString) - .Replace("${ConsensusSeedPublicKey}", data.ConsensusSeedPublicKey); - } - else - { - templateContent = templateContent - .Replace("${Apv}", data.Apv) - .Replace("${GenesisBlockPath}", data.GenesisBlockPath) - .Replace("${StorePath}", data.StorePath) - .Replace("${MinerPrivateKeyString}", data.MinerPrivateKeyString) - .Replace("${ConsensusPrivateKeyString}", data.ConsensusPrivateKeyString) - .Replace("${ConsensusSeedPublicKey}", data.ConsensusSeedPublicKey); - } - result = templateContent; - } - else - { - var appsettingsContent = File.ReadAllText(appsettingsPath); - var jsonDoc = JsonNode.Parse(appsettingsContent); - if (jsonDoc != null && jsonDoc["Headless"] != null) - { - jsonDoc["Headless"]["AppProtocolVersionString"] = data.Apv; - } - result = jsonDoc.ToJsonString(new JsonSerializerOptions { WriteIndented = true }); - } - - Directory.CreateDirectory(Paths.AppsettingsPath); - File.WriteAllText(appsettingsPath, result); - } -} diff --git a/NineChronicles.Headless.Executor/README.md b/NineChronicles.Headless.Executor/README.md deleted file mode 100644 index f0bff0fb0..000000000 --- a/NineChronicles.Headless.Executor/README.md +++ /dev/null @@ -1,81 +0,0 @@ -### NineChronicles.Headless.Executor - -``` -# NineChronicles.Headless.Executor - -This project provides a command-line interface (CLI) to manage and execute different versions of NineChronicles Headless nodes. You can install, list, and run the headless node for specific networks such as `MainnetOdin`, `MainnetHeimdall`, or `Single`. - -## Prerequisites - -- .NET SDK 6.0 or later -- Internet connection for downloading headless versions and necessary configuration files - -## Installation - -Clone the repository and navigate to the project folder: - -```bash -git clone -cd NineChronicles.Headless.Executor -``` - -## Build and Run - -You can build and run the project using the following commands: - -```bash -dotnet build -dotnet run -- [options] -``` - -## Commands - -### Install - -Install a specific version of NineChronicles Headless: - -```bash -dotnet run -- install [--os ] -``` - -- ``: The version of NineChronicles.Headless to download. -- `--os`: Optionally specify the OS platform (auto-detected if not provided). - -### List Versions - -List installed versions or remote versions available for download: - -```bash -dotnet run -- versions [--remote] [--page ] -``` - -- `--remote`: If provided, lists remote versions available for download. -- `--page`: Specifies the page number for pagination of remote versions. - -### Run - -Run a specific version of NineChronicles Headless on a given network: - -```bash -dotnet run -- run -``` - -- ``: The version of NineChronicles.Headless to run. -- ``: The network to run the headless node on (e.g., `MainnetOdin`, `MainnetHeimdall`, `Single`). - -The `run` command automatically downloads the necessary configuration files (e.g., templates, genesis block) if they are not already present locally. - -### Example - -To run version `v100000` of NineChronicles Headless on the `MainnetOdin` network: - -```bash -dotnet run -- run v100000 MainnetOdin -``` - -## Configuration - -The project automatically downloads the necessary configuration files, such as templates and genesis blocks, when running the headless node. These files are saved in user directories for reuse. - -- Configuration templates are stored in `~/.planetarium/headless/templates/`. -- Genesis blocks are stored in `~/.planetarium/headless/genesis-block/`. From 628d2a5755ad794069c80e1e1d6732f6e14d5cc5 Mon Sep 17 00:00:00 2001 From: s2quake Date: Thu, 21 Nov 2024 10:35:20 +0900 Subject: [PATCH 03/16] fix: Add configuration to host builder --- NineChronicles.Headless.Executable/Program.cs | 1 + 1 file changed, 1 insertion(+) diff --git a/NineChronicles.Headless.Executable/Program.cs b/NineChronicles.Headless.Executable/Program.cs index fcf00694f..8caff2e51 100644 --- a/NineChronicles.Headless.Executable/Program.cs +++ b/NineChronicles.Headless.Executable/Program.cs @@ -331,6 +331,7 @@ public async Task Run( try { IHostBuilder hostBuilder = Host.CreateDefaultBuilder(); + hostBuilder.ConfigureAppConfiguration(builder => builder.AddConfiguration(configuration)); var standaloneContext = new StandaloneContext { From 069868f212af4b99a187474550de4fa9a15c08f7 Mon Sep 17 00:00:00 2001 From: moreal Date: Thu, 28 Nov 2024 16:29:17 +0900 Subject: [PATCH 04/16] ci(gh-actions): fix tagging docker image --- .github/workflows/push_docker_image.yml | 9 ++++----- 1 file changed, 4 insertions(+), 5 deletions(-) diff --git a/.github/workflows/push_docker_image.yml b/.github/workflows/push_docker_image.yml index b58e6b7ae..6caf2cd39 100644 --- a/.github/workflows/push_docker_image.yml +++ b/.github/workflows/push_docker_image.yml @@ -76,14 +76,13 @@ jobs: --password '${{ secrets.DOCKER_HUB_ACCESS_TOKEN }}' - name: push git tagged version run: | - docker pull ${{ matrix.docker.repo }}:git-${{ github.sha }} if [[ -z "${{ github.event.inputs.imageTag }}" ]]; then export IMAGE_TAG=${{ github.ref_name }} else export IMAGE_TAG=${{ github.event.inputs.imageTag }} fi - docker tag \ - ${{ matrix.docker.repo }}:git-${{ github.sha }} \ - ${{ matrix.docker.repo }}:$IMAGE_TAG - docker push ${{ matrix.docker.repo }}:$IMAGE_TAG + docker buildx imagetools create \ + --progress=plain \ + --tag ${{ matrix.docker.repo }}:$IMAGE_TAG \ + ${{ matrix.docker.repo }}:git-${{ github.sha }} From 9d04a7bee99b4f71eceff3c7a4af64783c54311e Mon Sep 17 00:00:00 2001 From: s2quake Date: Thu, 5 Dec 2024 15:34:53 +0900 Subject: [PATCH 05/16] feat: Add state query for delegation --- .../GraphTypes/StateQuery.cs | 19 +++++ .../GraphTypes/ValidatorType.cs | 74 +++++++++++++++++++ 2 files changed, 93 insertions(+) create mode 100644 NineChronicles.Headless/GraphTypes/ValidatorType.cs diff --git a/NineChronicles.Headless/GraphTypes/StateQuery.cs b/NineChronicles.Headless/GraphTypes/StateQuery.cs index 7f07af304..302c9a817 100644 --- a/NineChronicles.Headless/GraphTypes/StateQuery.cs +++ b/NineChronicles.Headless/GraphTypes/StateQuery.cs @@ -772,6 +772,25 @@ public StateQuery() return share.ToString(); } ); + + Field( + name: "validator", + description: "State for validator.", + arguments: new QueryArguments( + new QueryArgument> + { + Name = "validatorAddress", + Description = "Address of validator." + } + ), + resolve: context => + { + var validatorAddress = context.GetArgument
("validatorAddress"); + var repository = new ValidatorRepository(new World(context.Source.WorldState), new HallowActionContext { }); + var delegatee = repository.GetValidatorDelegatee(validatorAddress); + return ValidatorType.FromDelegatee(delegatee); + } + ); } public static List GetRuneOptions( diff --git a/NineChronicles.Headless/GraphTypes/ValidatorType.cs b/NineChronicles.Headless/GraphTypes/ValidatorType.cs new file mode 100644 index 000000000..171d4f1ae --- /dev/null +++ b/NineChronicles.Headless/GraphTypes/ValidatorType.cs @@ -0,0 +1,74 @@ +using System.Numerics; +using GraphQL.Types; +using Libplanet.Types.Assets; +using Nekoyume.ValidatorDelegation; + +namespace NineChronicles.Headless.GraphTypes; + +public class ValidatorType : ObjectGraphType +{ + public BigInteger Power { get; set; } + + public bool IsActive { get; set; } + + public BigInteger TotalShares { get; set; } + + public bool Jailed { get; set; } + + public long JailedUntil { get; set; } + + public bool Tombstoned { get; set; } + + public FungibleAssetValue TotalDelegated { get; set; } + + public BigInteger CommissionPercentage { get; set; } + + public ValidatorType() + { + Field>( + nameof(Power), + description: "Power of validator", + resolve: context => context.Source.Power.ToString("N0")); + Field>( + nameof(IsActive), + description: "Specifies whether the validator is active.", + resolve: context => context.Source.IsActive); + Field>( + nameof(TotalShares), + description: "Total shares of validator", + resolve: context => context.Source.TotalShares.ToString("N0")); + Field>( + nameof(Jailed), + description: "Specifies whether the validator is jailed.", + resolve: context => context.Source.Jailed); + Field>( + nameof(JailedUntil), + description: "Block height until which the validator is jailed.", + resolve: context => context.Source.JailedUntil); + Field>( + nameof(Tombstoned), + description: "Specifies whether the validator is tombstoned.", + resolve: context => context.Source.Tombstoned); + Field>( + nameof(TotalDelegated), + description: "Total delegated amount of the validator.", + resolve: context => context.Source.TotalDelegated); + Field>( + nameof(CommissionPercentage), + description: "Commission percentage of the validator.", + resolve: context => context.Source.CommissionPercentage.ToString("N0")); + } + + public static ValidatorType FromDelegatee(ValidatorDelegatee validatorDelegatee) => + new ValidatorType + { + Power = validatorDelegatee.Power, + IsActive = validatorDelegatee.IsActive, + TotalShares = validatorDelegatee.TotalShares, + Jailed = validatorDelegatee.Jailed, + JailedUntil = validatorDelegatee.JailedUntil, + Tombstoned = validatorDelegatee.Tombstoned, + TotalDelegated = validatorDelegatee.TotalDelegated, + CommissionPercentage = validatorDelegatee.CommissionPercentage, + }; +} From 5a1dab659797e30f95014db12fe7b51884d0c6c2 Mon Sep 17 00:00:00 2001 From: s2quake Date: Thu, 5 Dec 2024 18:07:50 +0900 Subject: [PATCH 06/16] test: StateQuery test code for validator --- .../GraphTypes/ValidatorTypeTest.cs | 78 +++++++++++++++++++ 1 file changed, 78 insertions(+) create mode 100644 NineChronicles.Headless.Tests/GraphTypes/ValidatorTypeTest.cs diff --git a/NineChronicles.Headless.Tests/GraphTypes/ValidatorTypeTest.cs b/NineChronicles.Headless.Tests/GraphTypes/ValidatorTypeTest.cs new file mode 100644 index 000000000..e96e125e5 --- /dev/null +++ b/NineChronicles.Headless.Tests/GraphTypes/ValidatorTypeTest.cs @@ -0,0 +1,78 @@ +using System.Collections.Generic; +using System.Collections.Immutable; +using System.Threading.Tasks; +using GraphQL.Execution; +using Libplanet.Types.Tx; +using Nekoyume.ValidatorDelegation; +using Xunit; +using Xunit.Abstractions; + +namespace NineChronicles.Headless.Tests.GraphTypes +{ + public class ValidatorTypeTest : GraphQLTestBase + { + public ValidatorTypeTest(ITestOutputHelper output) : base(output) + { + } + + [Fact] + public async Task ExecuteQuery() + { + // Given + var block = BlockChain.Tip; + var blockHeight = 0L; + var tip = new Domain.Model.BlockChain.Block( + Hash: block.Hash, + PreviousHash: null, + Miner: ProposerPrivateKey.Address, + Index: blockHeight, + Timestamp: block.Timestamp, + StateRootHash: block.StateRootHash, + Transactions: ImmutableArray.Empty); + var worldState = BlockChain.GetNextWorldState(); + var stateRootHash = block.StateRootHash; + var validatorAddress = ProposerPrivateKey.Address.ToHex(); + var query = + $"query {{\n" + + $" stateQuery(index: 0) {{\n" + + $" validator(validatorAddress: \"{validatorAddress}\") {{\n" + + $" power\n" + + $" isActive\n" + + $" totalShares\n" + + $" jailed\n" + + $" jailedUntil\n" + + $" tombstoned\n" + + $" commissionPercentage\n" + + $" totalDelegated {{\n" + + $" currency\n" + + $" quantity\n" + + $" }}\n" + + $" }}\n" + + $" }}\n" + + $"}}\n"; + + BlockChainRepository.Setup(repository => repository.GetBlock(blockHeight)).Returns(tip); + WorldStateRepository.Setup(repository => repository.GetWorldState(stateRootHash)).Returns(worldState); + + // When + var result = await ExecuteQueryAsync(query); + + // Then + var data = (Dictionary)((ExecutionNode)result.Data!).ToValue()!; + var stateQueryResult = (Dictionary)data["stateQuery"]; + var validatorResult = (Dictionary)stateQueryResult["validator"]; + + Assert.Equal("10,000,000,000,000,000,000", validatorResult["power"]); + Assert.Equal(true, validatorResult["isActive"]); + Assert.Equal("10,000,000,000,000,000,000", validatorResult["totalShares"]); + Assert.Equal(false, validatorResult["jailed"]); + Assert.Equal(-1L, validatorResult["jailedUntil"]); + Assert.Equal(false, validatorResult["tombstoned"]); + Assert.Equal($"{ValidatorDelegatee.DefaultCommissionPercentage}", validatorResult["commissionPercentage"]); + + var totalDelegatedResult = (Dictionary)validatorResult["totalDelegated"]; + Assert.Equal("GUILD_GOLD", totalDelegatedResult["currency"]); + Assert.Equal("10.000000000000000000", totalDelegatedResult["quantity"]); + } + } +} From 007a5a49e629e6ed5ab15114f1b916ae09973e07 Mon Sep 17 00:00:00 2001 From: eugene-hong <58686228+eugene-doobu@users.noreply.github.com> Date: Wed, 11 Dec 2024 17:42:25 +0900 Subject: [PATCH 07/16] Bump lib9c 1.21.0 --- Lib9c | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Lib9c b/Lib9c index 7bee0e5a8..487fca896 160000 --- a/Lib9c +++ b/Lib9c @@ -1 +1 @@ -Subproject commit 7bee0e5a8f67d09c31713c194b87fccff20a3124 +Subproject commit 487fca8967c8f867cf85dd78b17f7e7c84f4efaf From 8a9d08aca25686ecf7a840f51c8af068cc1c529a Mon Sep 17 00:00:00 2001 From: Yang Chun Ung Date: Thu, 12 Dec 2024 21:03:20 +0900 Subject: [PATCH 08/16] Use StateRootHash instead of BlockHash --- NineChronicles.Headless/BlockChainService.cs | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/NineChronicles.Headless/BlockChainService.cs b/NineChronicles.Headless/BlockChainService.cs index 0c2bff96f..7553cc7b4 100644 --- a/NineChronicles.Headless/BlockChainService.cs +++ b/NineChronicles.Headless/BlockChainService.cs @@ -277,7 +277,7 @@ public UnaryResult> GetSheets( sw.Restart(); if (addresses.Any()) { - var stateRootHash = new BlockHash(stateRootHashBytes); + var stateRootHash = new HashDigest(stateRootHashBytes); IReadOnlyList values = _blockChain.GetWorldState(stateRootHash).GetLegacyStates(addresses); sw.Stop(); Log.Information("[GetSheets]Get sheet from state: {Count}, Elapsed: {Elapsed}", addresses.Count, sw.Elapsed); From 0bd18c8ad632813e617f411dac52976c8d092613 Mon Sep 17 00:00:00 2001 From: eugene-hong <58686228+eugene-doobu@users.noreply.github.com> Date: Fri, 13 Dec 2024 13:36:04 +0900 Subject: [PATCH 09/16] bump lib9c --- Lib9c | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Lib9c b/Lib9c index 487fca896..af4013a61 160000 --- a/Lib9c +++ b/Lib9c @@ -1 +1 @@ -Subproject commit 487fca8967c8f867cf85dd78b17f7e7c84f4efaf +Subproject commit af4013a61648cc178a27ca5d50a89b0f7e21c97a From 948e515912cd4fb29ceabbf28a39882c9c8da422 Mon Sep 17 00:00:00 2001 From: Chanhyuck Ko Date: Fri, 13 Dec 2024 16:38:21 +0900 Subject: [PATCH 10/16] bump: libplanet 5.4.2 --- Directory.Build.props | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Directory.Build.props b/Directory.Build.props index c95b6df16..ec7a28c36 100644 --- a/Directory.Build.props +++ b/Directory.Build.props @@ -1,5 +1,5 @@ - 5.4.1 + 5.4.2 From 2d168ff2921c8c4559a2e9ab38ed29daf3550c98 Mon Sep 17 00:00:00 2001 From: Chanhyuck Ko Date: Sun, 8 Dec 2024 15:34:02 +0900 Subject: [PATCH 11/16] feat: delay precommit option (cherry picked from commit 8baa875b5d954453600dbc54025273d3c50c61d2) (cherry picked from commit d4efac73e6d66a24bb94c8f7296fff5afd5b91de) --- .../Hosting/LibplanetNodeService.cs | 2 +- .../Hosting/LibplanetNodeServiceProperties.cs | 2 +- .../Configuration.cs | 9 ++- NineChronicles.Headless.Executable/Program.cs | 65 +++++++++++++++---- .../NineChroniclesNodeServiceProperties.cs | 12 ++-- 5 files changed, 69 insertions(+), 21 deletions(-) diff --git a/Libplanet.Headless/Hosting/LibplanetNodeService.cs b/Libplanet.Headless/Hosting/LibplanetNodeService.cs index c0b0c3f46..d9b353f56 100644 --- a/Libplanet.Headless/Hosting/LibplanetNodeService.cs +++ b/Libplanet.Headless/Hosting/LibplanetNodeService.cs @@ -238,7 +238,7 @@ IActionEvaluator BuildActionEvaluator(IActionEvaluatorConfiguration actionEvalua ConsensusPrivateKey = Properties.ConsensusPrivateKey, ConsensusWorkers = 500, TargetBlockInterval = TimeSpan.FromMilliseconds(Properties.ConsensusTargetBlockIntervalMilliseconds ?? 7000), - ContextTimeoutOptions = Properties.ContextTimeoutOption, + ContextOption = Properties.ContextOption, }; } diff --git a/Libplanet.Headless/Hosting/LibplanetNodeServiceProperties.cs b/Libplanet.Headless/Hosting/LibplanetNodeServiceProperties.cs index b174f398c..5d93d6a0c 100644 --- a/Libplanet.Headless/Hosting/LibplanetNodeServiceProperties.cs +++ b/Libplanet.Headless/Hosting/LibplanetNodeServiceProperties.cs @@ -68,7 +68,7 @@ public class LibplanetNodeServiceProperties public TimeSpan TipTimeout { get; set; } = TimeSpan.FromSeconds(60); - public ContextTimeoutOption ContextTimeoutOption { get; set; } + public ContextOption ContextOption { get; set; } public int DemandBuffer { get; set; } = 1150; diff --git a/NineChronicles.Headless.Executable/Configuration.cs b/NineChronicles.Headless.Executable/Configuration.cs index 0f0d9c6f2..2606e8363 100644 --- a/NineChronicles.Headless.Executable/Configuration.cs +++ b/NineChronicles.Headless.Executable/Configuration.cs @@ -87,7 +87,8 @@ public class Configuration public string[]? ConsensusSeedStrings { get; set; } public ushort? ConsensusPort { get; set; } public double? ConsensusTargetBlockIntervalMilliseconds { get; set; } - public int? ConsensusProposeSecondBase { get; set; } + public int? ConsensusProposeTimeoutBase { get; set; } + public int? ConsensusEnterPreCommitDelay { get; set; } public int? MaxTransactionPerBlock { get; set; } @@ -139,7 +140,8 @@ public void Overwrite( string? consensusPrivateKeyString, string[]? consensusSeedStrings, double? consensusTargetBlockIntervalMilliseconds, - int? consensusProposeSecondBase, + int? consensusProposeTimeoutBase, + int? consensusEnterPreCommitDelay, int? maxTransactionPerBlock, bool? remoteKeyValueService ) @@ -190,7 +192,8 @@ public void Overwrite( ConsensusSeedStrings = consensusSeedStrings ?? ConsensusSeedStrings; ConsensusPrivateKeyString = consensusPrivateKeyString ?? ConsensusPrivateKeyString; ConsensusTargetBlockIntervalMilliseconds = consensusTargetBlockIntervalMilliseconds ?? ConsensusTargetBlockIntervalMilliseconds; - ConsensusProposeSecondBase = consensusProposeSecondBase ?? ConsensusProposeSecondBase; + ConsensusProposeTimeoutBase = consensusProposeTimeoutBase ?? ConsensusProposeTimeoutBase; + ConsensusEnterPreCommitDelay = consensusEnterPreCommitDelay ?? ConsensusEnterPreCommitDelay; MaxTransactionPerBlock = maxTransactionPerBlock ?? MaxTransactionPerBlock; RemoteKeyValueService = remoteKeyValueService ?? RemoteKeyValueService; } diff --git a/NineChronicles.Headless.Executable/Program.cs b/NineChronicles.Headless.Executable/Program.cs index 8caff2e51..bd500945c 100644 --- a/NineChronicles.Headless.Executable/Program.cs +++ b/NineChronicles.Headless.Executable/Program.cs @@ -209,6 +209,9 @@ public async Task Run( [Option("consensus-propose-second-base", Description = "A propose second base for consensus context timeout. The unit is second.")] int? consensusProposeSecondBase = null, + [Option("consensus-enter-precommit-delay", + Description = "A precommit delay manually set. The unit is millisecond.")] + int? consensusEnterPreCommitDelay = null, [Option("maximum-transaction-per-block", Description = "Maximum transactions allowed in a block. null by default.")] int? maxTransactionPerBlock = null, @@ -290,16 +293,55 @@ public async Task Run( GetActionEvaluatorConfiguration(configuration.GetSection("Headless").GetSection("ActionEvaluator")); headlessConfig.Overwrite( - appProtocolVersionToken, trustedAppProtocolVersionSigners, genesisBlockPath, host, port, - swarmPrivateKeyString, storeType, storePath, noReduceStore, noMiner, minerCount, - minerPrivateKeyString, minerBlockIntervalMilliseconds, planet, iceServerStrings, peerStrings, rpcServer, rpcListenHost, - rpcListenPort, rpcRemoteServer, rpcHttpServer, graphQLServer, graphQLHost, graphQLPort, - graphQLSecretTokenPath, noCors, nonblockRenderer, nonblockRendererQueue, strictRendering, - logActionRenders, confirmations, - txLifeTime, messageTimeout, tipTimeout, demandBuffer, skipPreload, - minimumBroadcastTarget, bucketSize, chainTipStaleBehaviorType, txQuotaPerSigner, maximumPollPeers, - consensusPort, consensusPrivateKeyString, consensusSeedStrings, consensusTargetBlockIntervalMilliseconds, consensusProposeSecondBase, - maxTransactionPerBlock, remoteKeyValueService + appProtocolVersionToken, + trustedAppProtocolVersionSigners, + genesisBlockPath, + host, + port, + swarmPrivateKeyString, + storeType, + storePath, + noReduceStore, + noMiner, + minerCount, + minerPrivateKeyString, + minerBlockIntervalMilliseconds, + planet, + iceServerStrings, + peerStrings, + rpcServer, + rpcListenHost, + rpcListenPort, + rpcRemoteServer, + rpcHttpServer, + graphQLServer, + graphQLHost, + graphQLPort, + graphQLSecretTokenPath, + noCors, + nonblockRenderer, + nonblockRendererQueue, + strictRendering, + logActionRenders, + confirmations, + txLifeTime, + messageTimeout, + tipTimeout, + demandBuffer, + skipPreload, + minimumBroadcastTarget, + bucketSize, + chainTipStaleBehaviorType, + txQuotaPerSigner, + maximumPollPeers, + consensusPort, + consensusPrivateKeyString, + consensusSeedStrings, + consensusTargetBlockIntervalMilliseconds, + consensusProposeSecondBase * 1_000, + consensusEnterPreCommitDelay, + maxTransactionPerBlock, + remoteKeyValueService ); // Clean-up previous temporary log files. @@ -367,7 +409,8 @@ public async Task Run( consensusPrivateKeyString: headlessConfig.ConsensusPrivateKeyString, consensusSeedStrings: headlessConfig.ConsensusSeedStrings, consensusTargetBlockIntervalMilliseconds: headlessConfig.ConsensusTargetBlockIntervalMilliseconds, - consensusProposeSecondBase: headlessConfig.ConsensusProposeSecondBase, + consensusProposeTimeoutBase: headlessConfig.ConsensusProposeTimeoutBase, + consensusEnterPreCommitDelay: headlessConfig.ConsensusEnterPreCommitDelay, maximumPollPeers: headlessConfig.MaximumPollPeers, actionEvaluatorConfiguration: actionEvaluatorConfiguration ); diff --git a/NineChronicles.Headless/Properties/NineChroniclesNodeServiceProperties.cs b/NineChronicles.Headless/Properties/NineChroniclesNodeServiceProperties.cs index f60740a03..edb306290 100644 --- a/NineChronicles.Headless/Properties/NineChroniclesNodeServiceProperties.cs +++ b/NineChronicles.Headless/Properties/NineChroniclesNodeServiceProperties.cs @@ -91,7 +91,8 @@ public static LibplanetNodeServiceProperties string? consensusPrivateKeyString = null, string[]? consensusSeedStrings = null, double? consensusTargetBlockIntervalMilliseconds = null, - int? consensusProposeSecondBase = null, + int? consensusProposeTimeoutBase = null, + int? consensusEnterPreCommitDelay = null, IActionEvaluatorConfiguration? actionEvaluatorConfiguration = null) { var swarmPrivateKey = string.IsNullOrEmpty(swarmPrivateKeyString) @@ -108,9 +109,10 @@ public static LibplanetNodeServiceProperties var peers = peerStrings.Select(PropertyParser.ParsePeer).ToImmutableArray(); var consensusSeeds = consensusSeedStrings?.Select(PropertyParser.ParsePeer).ToImmutableList(); - var consensusContextTimeoutOption = consensusProposeSecondBase.HasValue - ? new ContextTimeoutOption(consensusProposeSecondBase.Value) - : new ContextTimeoutOption(); + var defaultContextOption = new ContextOption(); + var consensusContextOption = new ContextOption( + proposeTimeoutBase: consensusProposeTimeoutBase ?? defaultContextOption.ProposeTimeoutBase, + enterPreCommitDelay: consensusEnterPreCommitDelay ?? defaultContextOption.EnterPreCommitDelay); return new LibplanetNodeServiceProperties { @@ -147,7 +149,7 @@ public static LibplanetNodeServiceProperties ConsensusSeeds = consensusSeeds, ConsensusPrivateKey = consensusPrivateKey, ConsensusTargetBlockIntervalMilliseconds = consensusTargetBlockIntervalMilliseconds, - ContextTimeoutOption = consensusContextTimeoutOption, + ContextOption = consensusContextOption, ActionEvaluatorConfiguration = actionEvaluatorConfiguration ?? new DefaultActionEvaluatorConfiguration(), }; } From 22aca9299cae6eddf23318de2665ee5cb7ea5a24 Mon Sep 17 00:00:00 2001 From: hyeon Date: Mon, 16 Dec 2024 09:47:48 +0900 Subject: [PATCH 12/16] Bump Libplanet to 5.4.2 --- Directory.Build.props | 2 +- Lib9c | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/Directory.Build.props b/Directory.Build.props index c95b6df16..ec7a28c36 100644 --- a/Directory.Build.props +++ b/Directory.Build.props @@ -1,5 +1,5 @@ - 5.4.1 + 5.4.2 diff --git a/Lib9c b/Lib9c index af4013a61..0e0124be7 160000 --- a/Lib9c +++ b/Lib9c @@ -1 +1 @@ -Subproject commit af4013a61648cc178a27ca5d50a89b0f7e21c97a +Subproject commit 0e0124be7831d85e682b534a64e16ca196c10917 From 23217ce88d653dc179c3cbfdf64dfbbfd97a0d8e Mon Sep 17 00:00:00 2001 From: area363 Date: Mon, 9 Dec 2024 10:12:21 +0900 Subject: [PATCH 13/16] override rate-limiter when using jwt --- NineChronicles.Headless/GraphQLService.cs | 34 +++++---- .../Middleware/CustomRateLimitMiddleware.cs | 72 ++++++++++++++++--- .../Middleware/HttpCaptureMiddleware.cs | 1 + .../HttpMultiAccountManagementMiddleware.cs | 58 ++++++++++++++- 4 files changed, 138 insertions(+), 27 deletions(-) diff --git a/NineChronicles.Headless/GraphQLService.cs b/NineChronicles.Headless/GraphQLService.cs index c68027eb6..74cbbdfe5 100644 --- a/NineChronicles.Headless/GraphQLService.cs +++ b/NineChronicles.Headless/GraphQLService.cs @@ -202,11 +202,14 @@ public void ConfigureServices(IServiceCollection services) "Admin")); // FIXME: Use ConfigurationException after bumping to .NET 8 or later. - options.AddPolicy( - JwtPolicyKey, - p => - p.RequireClaim("iss", - jwtOptions["Issuer"] ?? throw new ArgumentException("jwtOptions[\"Issuer\"] is null."))); + if (Convert.ToBoolean(Configuration.GetSection("Jwt")["EnableJwtAuthentication"])) + { + options.AddPolicy( + JwtPolicyKey, + p => + p.RequireClaim("iss", + jwtOptions["Issuer"] ?? throw new ArgumentException("jwtOptions[\"Issuer\"] is null."))); + } }); services.AddGraphTypes(); @@ -220,6 +223,17 @@ public void Configure(IApplicationBuilder app, IWebHostEnvironment env) } // Capture requests + app.UseMiddleware(); + + app.UseRouting(); + app.UseAuthorization(); + if (Convert.ToBoolean(Configuration.GetSection("IpRateLimiting")["EnableEndpointRateLimiting"])) + { + app.UseMiddleware(); + app.UseMiddleware(); + app.UseMvc(); + } + if (Convert.ToBoolean(Configuration.GetSection("MultiAccountManaging")["EnableManaging"])) { ConcurrentDictionary> ipSignerList = new(); @@ -229,7 +243,6 @@ public void Configure(IApplicationBuilder app, IWebHostEnvironment env) Publisher); } - app.UseMiddleware(); app.UseMiddleware(); if (Convert.ToBoolean(Configuration.GetSection("Jwt")["EnableJwtAuthentication"])) @@ -246,15 +259,6 @@ public void Configure(IApplicationBuilder app, IWebHostEnvironment env) app.UseCors("AllowAllOrigins"); } - app.UseRouting(); - app.UseAuthorization(); - if (Convert.ToBoolean(Configuration.GetSection("IpRateLimiting")["EnableEndpointRateLimiting"])) - { - app.UseMiddleware(); - app.UseMiddleware(); - app.UseMvc(); - } - app.UseEndpoints(endpoints => { endpoints.MapControllers(); diff --git a/NineChronicles.Headless/Middleware/CustomRateLimitMiddleware.cs b/NineChronicles.Headless/Middleware/CustomRateLimitMiddleware.cs index a1b3df76b..28b914fc3 100644 --- a/NineChronicles.Headless/Middleware/CustomRateLimitMiddleware.cs +++ b/NineChronicles.Headless/Middleware/CustomRateLimitMiddleware.cs @@ -6,32 +6,52 @@ using NineChronicles.Headless.Properties; using Serilog; using ILogger = Serilog.ILogger; +using System.Linq; +using Microsoft.Extensions.Configuration; namespace NineChronicles.Headless.Middleware { + public class CustomRateLimitMiddleware : RateLimitMiddleware { private readonly ILogger _logger; private readonly IRateLimitConfiguration _config; private readonly IOptions _options; + private readonly string _whitelistedIp; + private readonly System.IdentityModel.Tokens.Jwt.JwtSecurityTokenHandler _tokenHandler = new(); + private readonly Microsoft.IdentityModel.Tokens.TokenValidationParameters _validationParams; public CustomRateLimitMiddleware(RequestDelegate next, IProcessingStrategy processingStrategy, IOptions options, IIpPolicyStore policyStore, - IRateLimitConfiguration config) + IRateLimitConfiguration config, + Microsoft.Extensions.Configuration.IConfiguration configuration) : base(next, options?.Value, new CustomIpRateLimitProcessor(options?.Value!, policyStore, processingStrategy), config) { _config = config; _options = options!; _logger = Log.Logger.ForContext(); + var jwtConfig = configuration.GetSection("Jwt"); + var issuer = jwtConfig["Issuer"] ?? ""; + var key = jwtConfig["Key"] ?? ""; + _whitelistedIp = configuration.GetSection("IpRateLimiting:IpWhitelist")?.Get()?.FirstOrDefault() ?? "127.0.0.1"; + _validationParams = new Microsoft.IdentityModel.Tokens.TokenValidationParameters + { + ValidateIssuer = true, + ValidateAudience = false, + ValidateLifetime = true, + ValidateIssuerSigningKey = true, + ValidIssuer = issuer, + IssuerSigningKey = new Microsoft.IdentityModel.Tokens.SymmetricSecurityKey(System.Text.Encoding.ASCII.GetBytes(key.PadRight(512 / 8, '\0'))) + }; } - protected override void LogBlockedRequest(HttpContext httpContext, ClientRequestIdentity identity, RateLimitCounter counter, RateLimitRule rule) + protected override void LogBlockedRequest(HttpContext context, ClientRequestIdentity identity, RateLimitCounter counter, RateLimitRule rule) { _logger.Information($"[IP-RATE-LIMITER] Request {identity.HttpVerb}:{identity.Path} from IP {identity.ClientIp} has been blocked, " + $"quota {rule.Limit}/{rule.Period} exceeded by {counter.Count - rule.Limit}. Blocked by rule {rule.Endpoint}, " + - $"TraceIdentifier {httpContext.TraceIdentifier}. MonitorMode: {rule.MonitorMode}"); + $"TraceIdentifier {context.TraceIdentifier}. MonitorMode: {rule.MonitorMode}"); if (counter.Count - rule.Limit >= _options.Value.IpBanThresholdCount) { _logger.Information($"[IP-RATE-LIMITER] Banning IP {identity.ClientIp}."); @@ -39,23 +59,57 @@ protected override void LogBlockedRequest(HttpContext httpContext, ClientRequest } } - public override async Task ResolveIdentityAsync(HttpContext httpContext) + public override async Task ResolveIdentityAsync(HttpContext context) { - var identity = await base.ResolveIdentityAsync(httpContext); + var identity = await base.ResolveIdentityAsync(context); - if (httpContext.Request.Protocol == "HTTP/1.1") + if (context.Request.Protocol == "HTTP/1.1") { - var body = await new StreamReader(httpContext.Request.Body).ReadToEndAsync(); - httpContext.Request.Body.Seek(0, SeekOrigin.Begin); + var body = context.Items["RequestBody"]!.ToString()!; + context.Request.Body.Seek(0, SeekOrigin.Begin); if (body.Contains("stageTransaction")) { identity.Path = "/graphql/stagetransaction"; } + } - return identity; + // Check for JWT secret key in headers + if (context.Request.Headers.TryGetValue("Authorization", out var authHeaderValue) && + authHeaderValue.Count > 0) + { + try + { + var (scheme, token) = ExtractSchemeAndToken(authHeaderValue); + if (scheme.Equals("Bearer", System.StringComparison.OrdinalIgnoreCase)) + { + _tokenHandler.ValidateToken(token, _validationParams, out _); + _logger.Information("[IP-RATE-LIMITER] Valid JWT token provided. Updating ClientIp to whitelisted IP."); + identity.ClientIp = _whitelistedIp; + } + } + catch (System.Exception ex) + { + _logger.Warning("[IP-RATE-LIMITER] JWT validation failed: {Message}", ex.Message); + } } return identity; } + + private (string scheme, string token) ExtractSchemeAndToken(Microsoft.Extensions.Primitives.StringValues authorizationHeader) + { + if (authorizationHeader.Count == 0 || string.IsNullOrWhiteSpace(authorizationHeader[0])) + { + throw new System.ArgumentException("Authorization header is missing or empty."); + } + + var headerValues = authorizationHeader[0]!.Split(" "); + if (headerValues.Length != 2) + { + throw new System.ArgumentException("Invalid Authorization header format. Expected 'Scheme Token'."); + } + + return (headerValues[0], headerValues[1]); + } } } diff --git a/NineChronicles.Headless/Middleware/HttpCaptureMiddleware.cs b/NineChronicles.Headless/Middleware/HttpCaptureMiddleware.cs index f6d9c0c95..54a9b89d4 100644 --- a/NineChronicles.Headless/Middleware/HttpCaptureMiddleware.cs +++ b/NineChronicles.Headless/Middleware/HttpCaptureMiddleware.cs @@ -25,6 +25,7 @@ public async Task InvokeAsync(HttpContext context) context.Request.EnableBuffering(); var remoteIp = context.Connection.RemoteIpAddress; var body = await new StreamReader(context.Request.Body).ReadToEndAsync(); + context.Items["RequestBody"] = body; _logger.Information("[GRAPHQL-REQUEST-CAPTURE] IP: {IP} Method: {Method} Endpoint: {Path} {Body}", remoteIp, context.Request.Method, context.Request.Path, body); context.Request.Body.Seek(0, SeekOrigin.Begin); diff --git a/NineChronicles.Headless/Middleware/HttpMultiAccountManagementMiddleware.cs b/NineChronicles.Headless/Middleware/HttpMultiAccountManagementMiddleware.cs index 4fee61167..ced8cc610 100644 --- a/NineChronicles.Headless/Middleware/HttpMultiAccountManagementMiddleware.cs +++ b/NineChronicles.Headless/Middleware/HttpMultiAccountManagementMiddleware.cs @@ -27,13 +27,16 @@ public class HttpMultiAccountManagementMiddleware private readonly ConcurrentDictionary> _ipSignerList; private readonly IOptions _options; private ActionEvaluationPublisher _publisher; + private readonly System.IdentityModel.Tokens.Jwt.JwtSecurityTokenHandler _tokenHandler = new(); + private readonly Microsoft.IdentityModel.Tokens.TokenValidationParameters _validationParams; public HttpMultiAccountManagementMiddleware( RequestDelegate next, StandaloneContext standaloneContext, ConcurrentDictionary> ipSignerList, IOptions options, - ActionEvaluationPublisher publisher) + ActionEvaluationPublisher publisher, + Microsoft.Extensions.Configuration.IConfiguration configuration) { _next = next; _logger = Log.Logger.ForContext(); @@ -41,6 +44,18 @@ public HttpMultiAccountManagementMiddleware( _ipSignerList = ipSignerList; _options = options; _publisher = publisher; + var jwtConfig = configuration.GetSection("Jwt"); + var issuer = jwtConfig["Issuer"] ?? ""; + var key = jwtConfig["Key"] ?? ""; + _validationParams = new Microsoft.IdentityModel.Tokens.TokenValidationParameters + { + ValidateIssuer = true, + ValidateAudience = false, + ValidateLifetime = true, + ValidateIssuerSigningKey = true, + ValidIssuer = issuer, + IssuerSigningKey = new Microsoft.IdentityModel.Tokens.SymmetricSecurityKey(System.Text.Encoding.ASCII.GetBytes(key.PadRight(512 / 8, '\0'))) + }; } private static void ManageMultiAccount(Address agent) @@ -58,9 +73,30 @@ public async Task InvokeAsync(HttpContext context) // Prevent to harm HTTP/2 communication. if (context.Request.Protocol == "HTTP/1.1") { - context.Request.EnableBuffering(); var remoteIp = context.Connection.RemoteIpAddress!.ToString(); - var body = await new StreamReader(context.Request.Body).ReadToEndAsync(); + + // Check for JWT secret key in headers + if (context.Request.Headers.TryGetValue("Authorization", out var authHeaderValue) && + authHeaderValue.Count > 0) + { + try + { + var (scheme, token) = ExtractSchemeAndToken(authHeaderValue); + if (scheme.Equals("Bearer", System.StringComparison.OrdinalIgnoreCase)) + { + _tokenHandler.ValidateToken(token, _validationParams, out _); + _logger.Information("[GRAPHQL-MULTI-ACCOUNT-MANAGER] Valid JWT token provided. Updating ClientIp to whitelisted IP."); + await _next(context); + return; + } + } + catch (System.Exception ex) + { + _logger.Warning("[GRAPHQL-MULTI-ACCOUNT-MANAGER] JWT validation failed: {Message}", ex.Message); + } + } + + var body = context.Items["RequestBody"]!.ToString()!; context.Request.Body.Seek(0, SeekOrigin.Begin); if (_options.Value.EnableManaging && body.Contains("stageTransaction")) { @@ -150,6 +186,22 @@ and not ClaimStakeReward await _next(context); } + private (string scheme, string token) ExtractSchemeAndToken(Microsoft.Extensions.Primitives.StringValues authorizationHeader) + { + if (authorizationHeader.Count == 0 || string.IsNullOrWhiteSpace(authorizationHeader[0])) + { + throw new System.ArgumentException("Authorization header is missing or empty."); + } + + var headerValues = authorizationHeader[0]!.Split(" "); + if (headerValues.Length != 2) + { + throw new System.ArgumentException("Invalid Authorization header format. Expected 'Scheme Token'."); + } + + return (headerValues[0], headerValues[1]); + } + private void UpdateIpSignerList(string ip, Address agent) { if (!_ipSignerList.ContainsKey(ip)) From bdfda089f8d733b6c8cd7ca7f8520653f6512ebc Mon Sep 17 00:00:00 2001 From: area363 Date: Tue, 10 Dec 2024 10:42:13 +0900 Subject: [PATCH 14/16] remove unnecessary log --- .../Middleware/CustomRateLimitMiddleware.cs | 1 - .../Middleware/HttpMultiAccountManagementMiddleware.cs | 8 -------- 2 files changed, 9 deletions(-) diff --git a/NineChronicles.Headless/Middleware/CustomRateLimitMiddleware.cs b/NineChronicles.Headless/Middleware/CustomRateLimitMiddleware.cs index 28b914fc3..d390c3c44 100644 --- a/NineChronicles.Headless/Middleware/CustomRateLimitMiddleware.cs +++ b/NineChronicles.Headless/Middleware/CustomRateLimitMiddleware.cs @@ -83,7 +83,6 @@ public override async Task ResolveIdentityAsync(HttpConte if (scheme.Equals("Bearer", System.StringComparison.OrdinalIgnoreCase)) { _tokenHandler.ValidateToken(token, _validationParams, out _); - _logger.Information("[IP-RATE-LIMITER] Valid JWT token provided. Updating ClientIp to whitelisted IP."); identity.ClientIp = _whitelistedIp; } } diff --git a/NineChronicles.Headless/Middleware/HttpMultiAccountManagementMiddleware.cs b/NineChronicles.Headless/Middleware/HttpMultiAccountManagementMiddleware.cs index ced8cc610..399d3bc42 100644 --- a/NineChronicles.Headless/Middleware/HttpMultiAccountManagementMiddleware.cs +++ b/NineChronicles.Headless/Middleware/HttpMultiAccountManagementMiddleware.cs @@ -85,7 +85,6 @@ public async Task InvokeAsync(HttpContext context) if (scheme.Equals("Bearer", System.StringComparison.OrdinalIgnoreCase)) { _tokenHandler.ValidateToken(token, _validationParams, out _); - _logger.Information("[GRAPHQL-MULTI-ACCOUNT-MANAGER] Valid JWT token provided. Updating ClientIp to whitelisted IP."); await _next(context); return; } @@ -211,13 +210,6 @@ private void UpdateIpSignerList(string ip, Address agent) ip); _ipSignerList[ip] = new HashSet
(); } - else - { - _logger.Information( - "[GRAPHQL-MULTI-ACCOUNT-MANAGER] List already created for IP: {IP} Count: {Count}", - ip, - _ipSignerList[ip].Count); - } _ipSignerList[ip].Add(agent); AddClientIpInfo(agent, ip); From 24543094ae6d820135894a2efd07d3a7dc4dffb3 Mon Sep 17 00:00:00 2001 From: Atralupus Date: Tue, 17 Dec 2024 16:19:37 +0900 Subject: [PATCH 15/16] bump lib9c 84f70 --- Lib9c | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Lib9c b/Lib9c index 0e0124be7..84f701a4d 160000 --- a/Lib9c +++ b/Lib9c @@ -1 +1 @@ -Subproject commit 0e0124be7831d85e682b534a64e16ca196c10917 +Subproject commit 84f701a4d08484a619db0113017b8d71fea8c480 From d60b66a13b83bfc9ec3987867181b9b521ca4754 Mon Sep 17 00:00:00 2001 From: area363 Date: Thu, 19 Dec 2024 12:37:02 +0900 Subject: [PATCH 16/16] add ratelimit for transactionresults --- .../appsettings.json | 6 ++ .../Middleware/CustomRateLimitMiddleware.cs | 62 +++++++++++++++++++ .../Middleware/HttpCaptureMiddleware.cs | 16 ++++- .../Middleware/IpBanMiddleware.cs | 10 +++ 4 files changed, 92 insertions(+), 2 deletions(-) diff --git a/NineChronicles.Headless.Executable/appsettings.json b/NineChronicles.Headless.Executable/appsettings.json index 3e4d70044..8f42ab9db 100644 --- a/NineChronicles.Headless.Executable/appsettings.json +++ b/NineChronicles.Headless.Executable/appsettings.json @@ -109,6 +109,11 @@ "Endpoint": "*:/graphql/stagetransaction", "Period": "60s", "Limit": 12 + }, + { + "Endpoint": "*:/graphql/transactionresults", + "Period": "60s", + "Limit": 60 } ], "QuotaExceededResponse": { @@ -117,6 +122,7 @@ "StatusCode": 429 }, "IpBanThresholdCount": 5, + "TransactionResultsBanThresholdCount": 100, "IpBanMinute" : 60, "IpBanResponse": { "Content": "{ \"message\": \"Your Ip has been banned.\" }", diff --git a/NineChronicles.Headless/Middleware/CustomRateLimitMiddleware.cs b/NineChronicles.Headless/Middleware/CustomRateLimitMiddleware.cs index d390c3c44..c86457be0 100644 --- a/NineChronicles.Headless/Middleware/CustomRateLimitMiddleware.cs +++ b/NineChronicles.Headless/Middleware/CustomRateLimitMiddleware.cs @@ -18,6 +18,7 @@ public class CustomRateLimitMiddleware : RateLimitMiddleware _options; private readonly string _whitelistedIp; + private readonly int _banCount; private readonly System.IdentityModel.Tokens.Jwt.JwtSecurityTokenHandler _tokenHandler = new(); private readonly Microsoft.IdentityModel.Tokens.TokenValidationParameters _validationParams; @@ -36,6 +37,7 @@ public CustomRateLimitMiddleware(RequestDelegate next, var issuer = jwtConfig["Issuer"] ?? ""; var key = jwtConfig["Key"] ?? ""; _whitelistedIp = configuration.GetSection("IpRateLimiting:IpWhitelist")?.Get()?.FirstOrDefault() ?? "127.0.0.1"; + _banCount = configuration.GetValue("IpRateLimiting:TransactionResultsBanThresholdCount", 100); _validationParams = new Microsoft.IdentityModel.Tokens.TokenValidationParameters { ValidateIssuer = true, @@ -71,6 +73,18 @@ public override async Task ResolveIdentityAsync(HttpConte { identity.Path = "/graphql/stagetransaction"; } + else if (body.Contains("transactionResults")) + { + identity.Path = "/graphql/transactionresults"; + + // Check for txIds count + var txIdsCount = CountTxIds(body); + if (txIdsCount > _banCount) + { + _logger.Information($"[IP-RATE-LIMITER] Banning IP {identity.ClientIp} due to excessive txIds count: {txIdsCount}"); + IpBanMiddleware.BanIp(identity.ClientIp); + } + } } // Check for JWT secret key in headers @@ -110,5 +124,53 @@ public override async Task ResolveIdentityAsync(HttpConte return (headerValues[0], headerValues[1]); } + + private int CountTxIds(string body) + { + try + { + var json = System.Text.Json.JsonDocument.Parse(body); + + // Check for txIds in query variables first + if (json.RootElement.TryGetProperty("variables", out var variables) && + variables.TryGetProperty("txIds", out var txIdsElement) && + txIdsElement.ValueKind == System.Text.Json.JsonValueKind.Array) + { + // Count from variables + return txIdsElement.GetArrayLength(); + } + + // Fallback to check the query string if variables are not set + if (json.RootElement.TryGetProperty("query", out var queryElement)) + { + var query = queryElement.GetString(); + if (!string.IsNullOrWhiteSpace(query)) + { + // Extract txIds from the query string using regex + var txIdMatches = System.Text.RegularExpressions.Regex.Matches( + query, @"transactionResults\s*\(\s*txIds\s*:\s*\[(?[^\]]*)\]" + ); + + if (txIdMatches.Count > 0) + { + // Extract the inner contents of txIds + var txIdList = txIdMatches[0].Groups["txIds"].Value; + + // Count txIds using commas + var txIds = txIdList.Split(',', System.StringSplitOptions.RemoveEmptyEntries | System.StringSplitOptions.TrimEntries); + + return txIds.Length; + } + } + } + } + catch (System.Exception ex) + { + _logger.Warning("[IP-RATE-LIMITER] Error parsing request body: {Message}", ex.Message); + } + + // Return 0 if txIds not found + return 0; + } } } diff --git a/NineChronicles.Headless/Middleware/HttpCaptureMiddleware.cs b/NineChronicles.Headless/Middleware/HttpCaptureMiddleware.cs index 54a9b89d4..a83f9745e 100644 --- a/NineChronicles.Headless/Middleware/HttpCaptureMiddleware.cs +++ b/NineChronicles.Headless/Middleware/HttpCaptureMiddleware.cs @@ -3,6 +3,7 @@ using Microsoft.AspNetCore.Http; using Serilog; using ILogger = Serilog.ILogger; +using Microsoft.Extensions.Configuration; namespace NineChronicles.Headless.Middleware { @@ -10,20 +11,31 @@ public class HttpCaptureMiddleware { private readonly RequestDelegate _next; private readonly ILogger _logger; + private readonly bool _enableIpRateLimiting; - public HttpCaptureMiddleware(RequestDelegate next) + public HttpCaptureMiddleware(RequestDelegate next, Microsoft.Extensions.Configuration.IConfiguration configuration) { _next = next; _logger = Log.Logger.ForContext(); + _enableIpRateLimiting = configuration.GetValue("IpRateLimiting:EnableEndpointRateLimiting"); } public async Task InvokeAsync(HttpContext context) { + var remoteIp = context.Connection.RemoteIpAddress!.ToString(); + + // Conditionally skip IP banning if endpoint rate-limiting is disabled + if (_enableIpRateLimiting && IpBanMiddleware.IsIpBanned(remoteIp)) + { + _logger.Information($"[GRAPHQL-REQUEST-CAPTURE] Skipping logging for banned IP: {remoteIp}"); + await _next(context); + return; + } + // Prevent to harm HTTP/2 communication. if (context.Request.Protocol == "HTTP/1.1") { context.Request.EnableBuffering(); - var remoteIp = context.Connection.RemoteIpAddress; var body = await new StreamReader(context.Request.Body).ReadToEndAsync(); context.Items["RequestBody"] = body; _logger.Information("[GRAPHQL-REQUEST-CAPTURE] IP: {IP} Method: {Method} Endpoint: {Path} {Body}", diff --git a/NineChronicles.Headless/Middleware/IpBanMiddleware.cs b/NineChronicles.Headless/Middleware/IpBanMiddleware.cs index 8f391e56e..6210cd39d 100644 --- a/NineChronicles.Headless/Middleware/IpBanMiddleware.cs +++ b/NineChronicles.Headless/Middleware/IpBanMiddleware.cs @@ -39,6 +39,16 @@ public static void UnbanIp(string ip) } } + public static bool IsIpBanned(string ip) + { + if (_bannedIps.ContainsKey(ip)) + { + return true; + } + + return false; + } + public Task InvokeAsync(HttpContext context) { var remoteIp = context.Connection.RemoteIpAddress!.ToString();