Merge pull request #2287 from greymistcube/rebase/release-70

🔀 Partially rebase release/70 and cherry-pick from release/62
planetarium · Nov 7, 2023 · f43535a · f43535a
2 parents ba98283 + b0e1912
commit f43535a
Show file tree

Hide file tree

Showing 18 changed files with 190 additions and 213 deletions.
diff --git a/.github/workflows/deploy_gh_pages.yaml b/.github/workflows/deploy_gh_pages.yaml
@@ -50,12 +50,20 @@ jobs:
             -G "https://9c-dx.s3.ap-northeast-2.amazonaws.com/empty-genesis-block-20230511" &
           sleep 60s
           graphql-inspector introspect http://localhost:30000/graphql --write schema.graphql
-      - name: Build
+      - name: Build GraphQL Document
         run: |
           yarn global add spectaql
-          spectaql ./spectaql-config.yaml
+          spectaql --target-dir public/graphql ./spectaql-config.yaml
+      - name: Build CLI Document
+        run: |
+          mkdir -p public/cli
+          dotnet run --project NineChronicles.Headless.Executable -- \
+            docs \
+            public/cli
+      - name: Copy Landing Page to deploy
+        run: cp Docs/resources/landing.html public/index.html
       - name: Copy GraphQL Schema to deploy
-        run: cp schema.graphql doc
+        run: cp schema.graphql public/schema.graphql
       - name: Deploy
         uses: peaceiris/actions-gh-pages@v3
         with:

diff --git a/.github/workflows/push_docker_image.yml b/.github/workflows/push_docker_image.yml
@@ -29,6 +29,8 @@ jobs:
         docker:
           - repo: planetariumhq/ninechronicles-headless
             dockerfile: Dockerfile
+          - repo: planetariumhq/access-control-center
+            dockerfile: Dockerfile.ACC
     if: github.ref_type == 'branch'
     runs-on: ubuntu-latest
     steps:

diff --git a/Docs/resources/landing.html b/Docs/resources/landing.html
@@ -0,0 +1,25 @@
+<!DOCTYPE html>
+<html>
+    <head>
+        <title>NineChronicles Headless</title>
+        <meta charset="UTF-8"/>
+        <script src="https://cdn.tailwindcss.com"></script>
+        <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/4.7.0/css/font-awesome.min.css">
+    </head>
+    <body>
+        <div class="flex min-h-screen min-w-screen justify-center items-center">
+            <div class="flex flex-col justify-center items-center gap-5">
+                <p class="bg-gray-700 p-5 text-white text-4xl font-extrabold">NineChronicles.Headless</p>
+                <span>A headless node to validate, network, operate NineChronicles chain.</span>
+                <hr class="w-full" />
+                <div class="flex flex-row justify-center items-center gap-2">
+                    <a href="https://github.com/planetarium/NineChronicles.Headless"><i class="fa fa-github"></i> Repository</a>
+                    <span>|</span>
+                    <a href="https://planetarium.github.io/NineChronicles.Headless/graphql">GraphQL Docs</a>
+                    <span>|</span>
+                    <a href="https://planetarium.github.io/NineChronicles.Headless/cli">CLI Docs</a>
+                </div>
+            </div>
+        </div>
+    </body>
+</html>
diff --git a/Lib9c b/Lib9c
diff --git a/...eadless.AccessControlCenter/AcsService.cs → ...eadless.AccessControlCenter/AccService.cs b/...eadless.AccessControlCenter/AcsService.cs → ...eadless.AccessControlCenter/AccService.cs
@@ -2,16 +2,16 @@
 using Microsoft.AspNetCore.Builder;
 using Microsoft.AspNetCore.Hosting;
 using Microsoft.AspNetCore.Server.Kestrel.Core;
-using Microsoft.Extensions.Configuration;
 using Microsoft.Extensions.DependencyInjection;
 using Microsoft.Extensions.Hosting;
+using Microsoft.OpenApi.Models;
 using NineChronicles.Headless.AccessControlCenter.AccessControlService;
 
 namespace NineChronicles.Headless.AccessControlCenter
 {
-    public class AcsService
+    public class AccService
     {
-        public AcsService(Configuration configuration)
+        public AccService(Configuration configuration)
         {
             Configuration = configuration;
         }
@@ -49,6 +49,33 @@ public void ConfigureServices(IServiceCollection services)
             {
                 services.AddControllers();
 
+                services.AddSwaggerGen(c =>
+                {
+                    c.SwaggerDoc(
+                        "v1",
+                        new OpenApiInfo { Title = "Access Control Center API", Version = "v1" }
+                    );
+                    c.DocInclusionPredicate(
+                        (docName, apiDesc) =>
+                        {
+                            var controllerType =
+                                apiDesc.ActionDescriptor
+                                as Microsoft.AspNetCore.Mvc.Controllers.ControllerActionDescriptor;
+                            if (controllerType != null)
+                            {
+                                var assemblyName = controllerType.ControllerTypeInfo.Assembly
+                                    .GetName()
+                                    .Name;
+                                var namespaceName = controllerType.ControllerTypeInfo.Namespace;
+                                return namespaceName?.StartsWith(
+                                        "NineChronicles.Headless.AccessControlCenter"
+                                    ) ?? false;
+                            }
+                            return false;
+                        }
+                    );
+                });
+
                 var accessControlService = MutableAccessControlServiceFactory.Create(
                     Enum.Parse<MutableAccessControlServiceFactory.StorageType>(
                         Configuration.AccessControlServiceType,
@@ -62,10 +89,11 @@ public void ConfigureServices(IServiceCollection services)
 
             public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
             {
-                if (env.IsDevelopment())
+                app.UseSwagger();
+                app.UseSwaggerUI(c =>
                 {
-                    app.UseDeveloperExceptionPage();
-                }
+                    c.SwaggerEndpoint("/swagger/v1/swagger.json", "Access Control Center API V1");
+                });
 
                 app.UseRouting();
                 app.UseAuthorization();

diff --git a/...onicles.Headless.AccessControlCenter/AccessControlService/IMutableAccessControlService.cs b/...onicles.Headless.AccessControlCenter/AccessControlService/IMutableAccessControlService.cs
@@ -6,8 +6,8 @@ namespace NineChronicles.Headless.AccessControlCenter.AccessControlService
 {
     public interface IMutableAccessControlService : IAccessControlService
     {
-        void DenyAccess(Address address);
-        void AllowAccess(Address address);
-        List<Address> ListBlockedAddresses(int offset, int limit);
+        void AddTxQuota(Address address, int quota);
+        void RemoveTxQuota(Address address);
+        List<Address> ListTxQuotaAddresses(int offset, int limit);
     }
 }
diff --git a/...les.Headless.AccessControlCenter/AccessControlService/MutableRedisAccessControlService.cs b/...les.Headless.AccessControlCenter/AccessControlService/MutableRedisAccessControlService.cs
@@ -2,34 +2,42 @@
 using System.Linq;
 using Libplanet.Crypto;
 using NineChronicles.Headless.Services;
+using StackExchange.Redis;
 
 namespace NineChronicles.Headless.AccessControlCenter.AccessControlService
 {
-    public class MutableRedisAccessControlService : RedisAccessControlService, IMutableAccessControlService
+    public class MutableRedisAccessControlService
+        : RedisAccessControlService,
+            IMutableAccessControlService
     {
-        public MutableRedisAccessControlService(string storageUri) : base(storageUri)
+        public MutableRedisAccessControlService(string storageUri)
+            : base(storageUri)
         {
         }
 
-        public void DenyAccess(Address address)
+        public void AddTxQuota(Address address, int quota)
         {
-            _db.StringSet(address.ToString(), "denied");
+            _db.StringSet(address.ToString(), quota.ToString());
         }
 
-        public void AllowAccess(Address address)
+        public void RemoveTxQuota(Address address)
         {
             _db.KeyDelete(address.ToString());
         }
 
-        public List<Address> ListBlockedAddresses(int offset, int limit)
+        public List<Address> ListTxQuotaAddresses(int offset, int limit)
         {
             var server = _db.Multiplexer.GetServer(_db.Multiplexer.GetEndPoints().First());
-            return server
-                .Keys()
-                .Select(k => new Address(k.ToString()))
-                .Skip(offset)
-                .Take(limit)
-                .ToList();
+
+            var result = (RedisResult[]?)
+                server.Execute("SCAN", offset.ToString(), "COUNT", limit.ToString());
+            if (result != null)
+            {
+                RedisKey[] keys = (RedisKey[])result[1]!;
+                return keys.Select(k => new Address(k.ToString())).ToList();
+            }
+
+            return new List<Address>();
         }
     }
 }
diff --git a/...es.Headless.AccessControlCenter/AccessControlService/MutableSqliteAccessControlService.cs b/...es.Headless.AccessControlCenter/AccessControlService/MutableSqliteAccessControlService.cs
@@ -1,3 +1,4 @@
+using System;
 using System.Collections.Generic;
 using Microsoft.Data.Sqlite;
 using Libplanet.Crypto;
@@ -7,55 +8,56 @@ namespace NineChronicles.Headless.AccessControlCenter.AccessControlService
 {
     public class MutableSqliteAccessControlService : SQLiteAccessControlService, IMutableAccessControlService
     {
-        private const string DenyAccessSql =
-            "INSERT OR IGNORE INTO blocklist (address) VALUES (@Address)";
-        private const string AllowAccessSql = "DELETE FROM blocklist WHERE address=@Address";
+        private const string AddTxQuotaSql =
+            "INSERT OR IGNORE INTO txquotalist (address, quota) VALUES (@Address, @Quota)";
+        private const string RemoveTxQuotaSql = "DELETE FROM txquotalist WHERE address=@Address";
 
         public MutableSqliteAccessControlService(string connectionString) : base(connectionString)
         {
         }
 
-        public void DenyAccess(Address address)
+        public void AddTxQuota(Address address, int quota)
         {
             using var connection = new SqliteConnection(_connectionString);
             connection.Open();
 
             using var command = connection.CreateCommand();
-            command.CommandText = DenyAccessSql;
+            command.CommandText = AddTxQuotaSql;
             command.Parameters.AddWithValue("@Address", address.ToString());
+            command.Parameters.AddWithValue("@Quota", quota);
             command.ExecuteNonQuery();
         }
 
-        public void AllowAccess(Address address)
+        public void RemoveTxQuota(Address address)
         {
             using var connection = new SqliteConnection(_connectionString);
             connection.Open();
 
             using var command = connection.CreateCommand();
-            command.CommandText = AllowAccessSql;
+            command.CommandText = RemoveTxQuotaSql;
             command.Parameters.AddWithValue("@Address", address.ToString());
             command.ExecuteNonQuery();
         }
 
-        public List<Address> ListBlockedAddresses(int offset, int limit)
+        public List<Address> ListTxQuotaAddresses(int offset, int limit)
         {
-            var blockedAddresses = new List<Address>();
+            var txQuotaAddresses = new List<Address>();
 
             using var connection = new SqliteConnection(_connectionString);
             connection.Open();
 
             using var command = connection.CreateCommand();
-            command.CommandText = $"SELECT address FROM blocklist LIMIT @Limit OFFSET @Offset";
+            command.CommandText = $"SELECT address FROM txquotalist LIMIT @Limit OFFSET @Offset";
             command.Parameters.AddWithValue("@Limit", limit);
             command.Parameters.AddWithValue("@Offset", offset);
 
             using var reader = command.ExecuteReader();
             while (reader.Read())
             {
-                blockedAddresses.Add(new Address(reader.GetString(0)));
+                txQuotaAddresses.Add(new Address(reader.GetString(0)));
             }
 
-            return blockedAddresses;
+            return txQuotaAddresses;
         }
     }
 }
diff --git a/NineChronicles.Headless.AccessControlCenter/Controllers/AccessControlServiceController.cs b/NineChronicles.Headless.AccessControlCenter/Controllers/AccessControlServiceController.cs
@@ -1,3 +1,4 @@
+using System;
 using System.Collections.Generic;
 using Microsoft.AspNetCore.Mvc;
 using NineChronicles.Headless.AccessControlCenter.AccessControlService;
@@ -17,30 +18,50 @@ public AccessControlServiceController(IMutableAccessControlService accessControl
         }
 
         [HttpGet("entries/{address}")]
-        public ActionResult<bool> IsAccessDenied(string address)
+        public ActionResult<int?> GetTxQuota(string address)
         {
-            return _accessControlService.IsAccessDenied(new Address(address));
+            return _accessControlService.GetTxQuota(new Address(address));
         }
 
-        [HttpPost("entries/{address}/deny")]
-        public ActionResult DenyAccess(string address)
+        [HttpPost("entries/add-tx-quota/{address}/{quota:int}")]
+        public ActionResult AddTxQuota(string address, int quota)
         {
-            _accessControlService.DenyAccess(new Address(address));
+            var maxQuota = 10;
+            if (quota > maxQuota)
+            {
+                return BadRequest($"The quota cannot exceed {maxQuota}.");
+            }
+
+            _accessControlService.AddTxQuota(new Address(address), quota);
             return Ok();
         }
 
-        [HttpPost("entries/{address}/allow")]
-        public ActionResult AllowAccess(string address)
+        [HttpPost("entries/remove-tx-quota/{address}")]
+        public ActionResult RemoveTxQuota(string address)
         {
-            _accessControlService.AllowAccess(new Address(address));
+            _accessControlService.RemoveTxQuota(new Address(address));
             return Ok();
         }
 
         [HttpGet("entries")]
         public ActionResult<List<string>> ListBlockedAddresses(int offset, int limit)
         {
+            var maxLimit = 10;
+            if (_accessControlService is MutableRedisAccessControlService)
+            {
+                maxLimit = 10;
+            }
+            else if (_accessControlService is MutableSqliteAccessControlService)
+            {
+                maxLimit = 100;
+            }
+            if (limit > maxLimit)
+            {
+                return BadRequest($"The limit cannot exceed {maxLimit}.");
+            }
+
             return _accessControlService
-                .ListBlockedAddresses(offset, limit)
+                .ListTxQuotaAddresses(offset, limit)
                 .Select(a => a.ToString())
                 .ToList();
         }

diff --git a/...hronicles.Headless.AccessControlCenter/NineChronicles.Headless.AccessControlCenter.csproj b/...hronicles.Headless.AccessControlCenter/NineChronicles.Headless.AccessControlCenter.csproj
@@ -22,6 +22,7 @@
       <PrivateAssets>all</PrivateAssets>
       <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
     </PackageReference>
+    <PackageReference Include="Swashbuckle.AspNetCore" Version="6.5.0" />
   </ItemGroup>
 
   <ItemGroup>

diff --git a/NineChronicles.Headless.AccessControlCenter/Program.cs b/NineChronicles.Headless.AccessControlCenter/Program.cs
@@ -20,7 +20,7 @@ public static void Main(string[] args)
             var acsConfig = new Configuration();
             config.Bind(acsConfig);
 
-            var service = new AcsService(acsConfig);
+            var service = new AccService(acsConfig);
             var hostBuilder = service.Configure(Host.CreateDefaultBuilder(), acsConfig.Port);
             var host = hostBuilder.Build();
             host.Run();

diff --git a/NineChronicles.Headless.Executable/NineChronicles.Headless.Executable.csproj b/NineChronicles.Headless.Executable/NineChronicles.Headless.Executable.csproj
@@ -20,6 +20,7 @@
 
   <ItemGroup>
     <PackageReference Include="Cocona.Lite" Version="2.1.*" />
+    <PackageReference Include="Cocona.Docs" Version="0.2.0-dev.2023103141721" />
     <PackageReference Include="Destructurama.Attributed" Version="2.0.0" />
     <PackageReference Include="Sentry.Serilog" Version="3.23.0" />
     <PackageReference Include="Sentry" Version="3.23.0" />

diff --git a/NineChronicles.Headless.Executable/Program.cs b/NineChronicles.Headless.Executable/Program.cs
@@ -43,6 +43,7 @@
 
 namespace NineChronicles.Headless.Executable
 {
+    [HasSubCommands(typeof(Cocona.Docs.DocumentCommand), "docs")]
     [HasSubCommands(typeof(AccountCommand), "account")]
     [HasSubCommands(typeof(ValidationCommand), "validation")]
     [HasSubCommands(typeof(ChainCommand), "chain")]

diff --git a/...eadless.Tests/GraphTypes/States/Models/CrystalMonsterCollectionMultiplierSheetTypeTest.cs b/...eadless.Tests/GraphTypes/States/Models/CrystalMonsterCollectionMultiplierSheetTypeTest.cs
@@ -59,6 +59,16 @@ public async Task Query()
                     ["level"] = 5,
                     ["multiplier"] = 300,
                 },
+                new Dictionary<string, object>
+                {
+                    ["level"] = 6,
+                    ["multiplier"] = 300,
+                },
+                new Dictionary<string, object>
+                {
+                    ["level"] = 7,
+                    ["multiplier"] = 300,
+                },
             };
             var expected = new Dictionary<string, object> { { "orderedList", list } };
             Assert.Equal(expected, data);