Merge pull request #3960 from riemannulus/imp/interfacing-policy-acti…

…on-registy 🔧 refactor: interfacing policy action registy
planetarium · Oct 8, 2024 · 9bd2216 · 9bd2216
2 parents cf42918 + fc702d0
commit 9bd2216
Show file tree

Hide file tree

Showing 16 changed files with 55 additions and 17 deletions.
diff --git a/CHANGES.md b/CHANGES.md
@@ -29,6 +29,8 @@ To be released.
     to `IReadOnlyList<BlockHash>`.  [[#3949]]
  -  (Libplanet.Net) Changed `ActionExecutionState` and `BlockVerificationState`
     to be `Obsolete`.  [[#3943]]
+ -  (Libplanet.Action) Export `IPolicyActionsRegistry` interface
+    from `PolicyActionsRegistry`.  [[#3960]]
 
 ### Backward-incompatible network protocol changes
 
@@ -66,6 +68,7 @@ To be released.
 [#3948]: https://github.com/planetarium/libplanet/pull/3948
 [#3949]: https://github.com/planetarium/libplanet/pull/3949
 [#3950]: https://github.com/planetarium/libplanet/pull/3950
+[#3960]: https://github.com/planetarium/libplanet/pull/3960
 
 
 Version 5.2.2

diff --git a/src/Libplanet.Action/ActionEvaluator.cs b/src/Libplanet.Action/ActionEvaluator.cs
@@ -24,7 +24,7 @@ namespace Libplanet.Action
     public class ActionEvaluator : IActionEvaluator
     {
         private readonly ILogger _logger;
-        private readonly PolicyActionsRegistry _policyActionsRegistry;
+        private readonly IPolicyActionsRegistry _policyActionsRegistry;
         private readonly IStateStore _stateStore;
         private readonly IActionLoader _actionLoader;
 
@@ -40,7 +40,7 @@ public class ActionEvaluator : IActionEvaluator
         /// <param name="actionTypeLoader"> A <see cref="IActionLoader"/> implementation using
         /// action type lookup.</param>
         public ActionEvaluator(
-            PolicyActionsRegistry policyActionsRegistry,
+            IPolicyActionsRegistry policyActionsRegistry,
             IStateStore stateStore,
             IActionLoader actionTypeLoader)
         {

diff --git a/src/Libplanet.Action/IPolicyActionsRegistry.cs b/src/Libplanet.Action/IPolicyActionsRegistry.cs
@@ -0,0 +1,36 @@
+using System.Collections.Immutable;
+
+namespace Libplanet.Action
+{
+    public interface IPolicyActionsRegistry
+    {
+        /// <summary>
+        /// An array of <see cref="IAction"/> to execute and be rendered at the beginning
+        /// for every block, if any.</summary>
+        ImmutableArray<IAction> BeginBlockActions
+        {
+            get;
+        }
+        /// <summary>
+        /// An array of <see cref="IAction"/> to execute and be rendered at the end
+        /// for every block, if any.</summary>
+        ImmutableArray<IAction> EndBlockActions
+        {
+            get;
+        }
+        /// <summary>
+        /// An array of <see cref="IAction"/> to execute and be rendered at the beginning
+        /// for every transaction, if any.</summary>
+        ImmutableArray<IAction> BeginTxActions
+        {
+            get;
+        }
+        /// <summary>
+        /// An array of <see cref="IAction"/> to execute and be rendered at the end
+        /// for every transaction, if any.</summary>
+        ImmutableArray<IAction> EndTxActions
+        {
+            get;
+        }
+    }
+}
diff --git a/src/Libplanet.Action/PolicyActionsRegistry.cs b/src/Libplanet.Action/PolicyActionsRegistry.cs
@@ -4,7 +4,7 @@
 
 namespace Libplanet.Action
 {
-    public class PolicyActionsRegistry
+    public class PolicyActionsRegistry : IPolicyActionsRegistry
     {
         /// <summary>
         /// A class containing policy actions to evaluate at each situation.

diff --git a/src/Libplanet/Blockchain/Policies/BlockPolicy.cs b/src/Libplanet/Blockchain/Policies/BlockPolicy.cs
@@ -22,7 +22,7 @@ public class BlockPolicy : IBlockPolicy
         private readonly Func<BlockChain, Block, BlockPolicyViolationException?>
             _validateNextBlock;
 
-        private readonly PolicyActionsRegistry _policyActionsRegistry;
+        private readonly IPolicyActionsRegistry _policyActionsRegistry;
         private readonly Func<long, long> _getMaxTransactionsBytes;
         private readonly Func<long, int> _getMinTransactionsPerBlock;
         private readonly Func<long, int> _getMaxTransactionsPerBlock;
@@ -73,7 +73,7 @@ public class BlockPolicy : IBlockPolicy
         /// Goes to <see cref="GetMaxEvidencePendingDuration"/>.  Set to a constant function
         /// of <c>10</c> by default.</param>
         public BlockPolicy(
-            PolicyActionsRegistry? policyActionsRegistry = null,
+            IPolicyActionsRegistry? policyActionsRegistry = null,
             TimeSpan? blockInterval = null,
             Func<BlockChain, Transaction, TxPolicyViolationException?>?
                 validateNextBlockTx = null,
@@ -169,7 +169,7 @@ public BlockPolicy(
             }
         }
 
-        public PolicyActionsRegistry PolicyActionsRegistry => _policyActionsRegistry;
+        public IPolicyActionsRegistry PolicyActionsRegistry => _policyActionsRegistry;
 
         /// <summary>
         /// Targeted time interval between two consecutive <see cref="Block"/>s.

diff --git a/src/Libplanet/Blockchain/Policies/IBlockPolicy.cs b/src/Libplanet/Blockchain/Policies/IBlockPolicy.cs
@@ -24,7 +24,7 @@ public interface IBlockPolicy
         /// <summary>
         /// A set of policy <see cref="IAction"/>s to evaluate at each situation.
         /// </summary>
-        PolicyActionsRegistry PolicyActionsRegistry { get; }
+        IPolicyActionsRegistry PolicyActionsRegistry { get; }
 
         /// <summary>
         /// Checks if a <see cref="Transaction"/> can be included in a yet to be mined

diff --git a/src/Libplanet/Blockchain/Policies/NullBlockPolicy.cs b/src/Libplanet/Blockchain/Policies/NullBlockPolicy.cs
@@ -21,7 +21,7 @@ public NullBlockPolicy(
 
         public ISet<Address> BlockedMiners { get; } = new HashSet<Address>();
 
-        public PolicyActionsRegistry PolicyActionsRegistry => new PolicyActionsRegistry();
+        public IPolicyActionsRegistry PolicyActionsRegistry => new PolicyActionsRegistry();
 
         public ImmutableArray<IAction> BeginBlockActions => ImmutableArray<IAction>.Empty;
 

diff --git a/test/Libplanet.RocksDBStore.Tests/RocksDBStoreBlockChainTest.cs b/test/Libplanet.RocksDBStore.Tests/RocksDBStoreBlockChainTest.cs
@@ -15,7 +15,7 @@ public RocksDBStoreBlockChainTest(ITestOutputHelper output)
         }
 
         protected override StoreFixture GetStoreFixture(
-            PolicyActionsRegistry policyActionsRegistry = null)
+            IPolicyActionsRegistry policyActionsRegistry = null)
         {
             try
             {

diff --git a/test/Libplanet.RocksDBStore.Tests/RocksDBStoreFixture.cs b/test/Libplanet.RocksDBStore.Tests/RocksDBStoreFixture.cs
@@ -10,7 +10,7 @@ namespace Libplanet.RocksDBStore.Tests
     public class RocksDBStoreFixture : StoreFixture
     {
         public RocksDBStoreFixture(
-            PolicyActionsRegistry policyActionsRegistry = null)
+            IPolicyActionsRegistry policyActionsRegistry = null)
             : base(policyActionsRegistry)
         {
             Path = System.IO.Path.Combine(

diff --git a/test/Libplanet.Tests/Blockchain/BlockChainTest.cs b/test/Libplanet.Tests/Blockchain/BlockChainTest.cs
@@ -1294,7 +1294,7 @@ void BuildIndex(Guid id, Block block)
         /// <param name="policyActionsRegistry">The policy block actions to use.</param>
         /// <returns>The store fixture that every test in this class depends on.</returns>
         protected virtual StoreFixture GetStoreFixture(
-            PolicyActionsRegistry policyActionsRegistry = null)
+            IPolicyActionsRegistry policyActionsRegistry = null)
             => new MemoryStoreFixture(policyActionsRegistry);
 
         private (Address[], Transaction[]) MakeFixturesForAppendTests(

diff --git a/test/Libplanet.Tests/Blockchain/DefaultStoreBlockChainTest.cs b/test/Libplanet.Tests/Blockchain/DefaultStoreBlockChainTest.cs
@@ -12,7 +12,7 @@ public DefaultStoreBlockChainTest(ITestOutputHelper output)
         }
 
         protected override StoreFixture GetStoreFixture(
-            PolicyActionsRegistry policyActionsRegistry = null) =>
+            IPolicyActionsRegistry policyActionsRegistry = null) =>
                 new DefaultStoreFixture(policyActionsRegistry: policyActionsRegistry);
     }
 }
diff --git a/test/Libplanet.Tests/Store/DefaultStoreFixture.cs b/test/Libplanet.Tests/Store/DefaultStoreFixture.cs
@@ -10,7 +10,7 @@ public class DefaultStoreFixture : StoreFixture, IDisposable
     {
         public DefaultStoreFixture(
             bool memory = true,
-            PolicyActionsRegistry policyActionsRegistry = null)
+            IPolicyActionsRegistry policyActionsRegistry = null)
             : base(policyActionsRegistry)
         {
             if (memory)

diff --git a/test/Libplanet.Tests/Store/MemoryStoreFixture.cs b/test/Libplanet.Tests/Store/MemoryStoreFixture.cs
@@ -7,7 +7,7 @@ namespace Libplanet.Tests.Store
     public class MemoryStoreFixture : StoreFixture
     {
         public MemoryStoreFixture(
-            PolicyActionsRegistry policyActionsRegistry = null)
+            IPolicyActionsRegistry policyActionsRegistry = null)
             : base(policyActionsRegistry)
         {
             Store = new MemoryStore();

diff --git a/test/Libplanet.Tests/Store/StoreFixture.cs b/test/Libplanet.Tests/Store/StoreFixture.cs
@@ -17,7 +17,7 @@ namespace Libplanet.Tests.Store
 {
     public abstract class StoreFixture : IDisposable
     {
-        protected StoreFixture(PolicyActionsRegistry policyActionsRegistry = null)
+        protected StoreFixture(IPolicyActionsRegistry policyActionsRegistry = null)
         {
             Path = null;
 

diff --git a/tools/Libplanet.Explorer.Cocona/Libplanet.Explorer.Cocona.csproj b/tools/Libplanet.Explorer.Cocona/Libplanet.Explorer.Cocona.csproj
@@ -8,7 +8,6 @@
   <ItemGroup>
     <PackageReference Include="Cocona.Lite" Version="2.0.*" />
     <PackageReference Include="Serilog.Sinks.Console" Version="4.1.0" />
-    <PackageReference Include="System.Text.Json" Version="7.0.0" />
   </ItemGroup>
 
   <ItemGroup>

diff --git a/tools/Libplanet.Explorer.Executable/Program.cs b/tools/Libplanet.Explorer.Executable/Program.cs
@@ -378,7 +378,7 @@ public DumbBlockPolicy(BlockPolicy blockPolicy)
                 _impl = blockPolicy;
             }
 
-            public PolicyActionsRegistry PolicyActionsRegistry => _impl.PolicyActionsRegistry;
+            public IPolicyActionsRegistry PolicyActionsRegistry => _impl.PolicyActionsRegistry;
 
             public int GetMinTransactionsPerBlock(long index) =>
                 _impl.GetMinTransactionsPerBlock(index);
-Original file line number
+Diff line change
@@ Expand Up / @@ -15,7 +15,7 @@ public RocksDBStoreBlockChainTest(ITestOutputHelper output) @@
             }
             protected override StoreFixture GetStoreFixture(
-                PolicyActionsRegistry policyActionsRegistry = null)
+                IPolicyActionsRegistry policyActionsRegistry = null)
             {
                 try
                 {
@@ Expand Down @@