refactor: separate PoSAction and implement ActionBase

planetarium · Apr 3, 2024 · ce02e8b · ce02e8b
1 parent 38f8d2f
commit ce02e8b
Show file tree

Hide file tree

Showing 10 changed files with 132 additions and 93 deletions.
diff --git a/Lib9c/Action/DPoS/DPoSBeginBlockAction.cs b/Lib9c/Action/DPoS/DPoSBeginBlockAction.cs
@@ -0,0 +1,51 @@
+using System.Collections.Immutable;
+using Bencodex.Types;
+using Libplanet.Action;
+using Libplanet.Action.State;
+using Nekoyume.Action.DPoS.Control;
+using Nekoyume.Action.DPoS.Misc;
+using Nekoyume.Action.DPoS.Model;
+using Nekoyume.Module;
+
+namespace Nekoyume.Action.DPoS
+{
+    /// <summary>
+    /// A BeginBlock action for DPoS that updates <see cref="ValidatorSet"/>.
+    /// </summary>
+    public sealed class DPoSBeginBlockAction : ActionBase
+    {
+        /// <summary>
+        /// Creates a new instance of <see cref="DPoSBeginBlockAction"/>.
+        /// </summary>
+        public DPoSBeginBlockAction()
+        {
+        }
+
+       /// <inheritdoc cref="IAction.PlainValue"/>
+        public override IValue PlainValue => new Bencodex.Types.Boolean(true);
+
+        /// <inheritdoc cref="IAction.LoadPlainValue(IValue)"/>
+        public override void LoadPlainValue(IValue plainValue)
+        {
+            // Method intentionally left empty.
+        }
+
+        /// <inheritdoc cref="IAction.Execute(IActionContext)"/>
+        public override IWorld Execute(IActionContext context)
+        {
+            var states = context.PreviousState;
+
+            // Allocate reward
+            var nativeTokens = ImmutableHashSet.Create(
+                Asset.GovernanceToken, Asset.ConsensusToken, Asset.Share);
+            states = AllocateReward.Execute(
+                states,
+                context,
+                nativeTokens,
+                context.LastCommit?.Votes,
+                context.Miner);
+
+            return states;
+        }
+    }
+}
diff --git a/Lib9c/Action/DPoS/DPoSEndBlockAction.cs b/Lib9c/Action/DPoS/DPoSEndBlockAction.cs
@@ -0,0 +1,53 @@
+using System.Collections.Immutable;
+using Bencodex.Types;
+using Libplanet.Action;
+using Libplanet.Action.State;
+using Nekoyume.Action.DPoS.Control;
+using Nekoyume.Action.DPoS.Misc;
+using Nekoyume.Action.DPoS.Model;
+using Nekoyume.Module;
+
+namespace Nekoyume.Action.DPoS
+{
+    /// <summary>
+    /// A EndBlock action for DPoS that updates <see cref="ValidatorSet"/>.
+    /// </summary>
+    public sealed class DPoSEndBlockAction : ActionBase
+    {
+        /// <summary>
+        /// Creates a new instance of <see cref="DPoSBeginBlockAction"/>.
+        /// </summary>
+        public DPoSEndBlockAction()
+        {
+        }
+
+       /// <inheritdoc cref="IAction.PlainValue"/>
+        public override IValue PlainValue => new Bencodex.Types.Boolean(true);
+
+        /// <inheritdoc cref="IAction.LoadPlainValue(IValue)"/>
+        public override void LoadPlainValue(IValue plainValue)
+        {
+            // Method intentionally left empty.
+        }
+
+        /// <inheritdoc cref="IAction.Execute(IActionContext)"/>
+        public override IWorld Execute(IActionContext context)
+        {
+            var states = context.PreviousState;
+
+            // Update ValidatorSet
+            states = ValidatorSetCtrl.Update(states, context);
+            ValidatorSet bondedSet;
+            (states, bondedSet) = ValidatorSetCtrl.FetchBondedValidatorSet(states);
+            foreach (var validator in bondedSet.Set)
+            {
+                states = states.SetValidator(
+                    new Libplanet.Types.Consensus.Validator(
+                        validator.OperatorPublicKey,
+                        validator.ConsensusToken.RawValue));
+            }
+
+            return states;
+        }
+    }
+}
diff --git a/Lib9c/Action/DPoS/PoSAction.cs b/Lib9c/Action/DPoS/PoSAction.cs
diff --git a/Lib9c/Action/DPoS/Sys/CancelUndelegation.cs b/Lib9c/Action/DPoS/Sys/CancelUndelegation.cs
@@ -16,7 +16,7 @@ namespace Nekoyume.Action.DPoS.Sys
     /// <see cref="Amount"/> of tokens to a given <see cref="Validator"/>.
     /// </summary>
     [ActionType(ActionTypeValue)]
-    public sealed class CancelUndelegation : IAction
+    public sealed class CancelUndelegation : ActionBase
     {
         private const string ActionTypeValue = "cancel_undelegation";
 
@@ -49,21 +49,21 @@ public CancelUndelegation()
         public FungibleAssetValue Amount { get; set; }
 
         /// <inheritdoc cref="IAction.PlainValue"/>
-        public IValue PlainValue => Bencodex.Types.Dictionary.Empty
+        public override IValue PlainValue => Bencodex.Types.Dictionary.Empty
             .Add("type_id", new Text(ActionTypeValue))
             .Add("validator", Validator.Serialize())
             .Add("amount", Amount.Serialize());
 
         /// <inheritdoc cref="IAction.LoadPlainValue(IValue)"/>
-        public void LoadPlainValue(IValue plainValue)
+        public override void LoadPlainValue(IValue plainValue)
         {
             var dict = (Bencodex.Types.Dictionary)plainValue;
             Validator = dict["validator"].ToAddress();
             Amount = dict["amount"].ToFungibleAssetValue();
         }
 
         /// <inheritdoc cref="IAction.Execute(IActionContext)"/>
-        public IWorld Execute(IActionContext context)
+        public override IWorld Execute(IActionContext context)
         {
             IActionContext ctx = context;
             var states = ctx.PreviousState;

diff --git a/Lib9c/Action/DPoS/Sys/Delegate.cs b/Lib9c/Action/DPoS/Sys/Delegate.cs
@@ -15,7 +15,7 @@ namespace Nekoyume.Action.DPoS.Sys
     /// of tokens to a given <see cref="Validator"/>.
     /// </summary>
     [ActionType(ActionTypeValue)]
-    public sealed class Delegate : IAction
+    public sealed class Delegate : ActionBase
     {
         private const string ActionTypeValue = "delegate";
 
@@ -44,21 +44,21 @@ public Delegate()
         public FungibleAssetValue Amount { get; set; }
 
         /// <inheritdoc cref="IAction.PlainValue"/>
-        public IValue PlainValue => Bencodex.Types.Dictionary.Empty
+        public override IValue PlainValue => Bencodex.Types.Dictionary.Empty
             .Add("type_id", new Text(ActionTypeValue))
             .Add("validator", Validator.Serialize())
             .Add("amount", Amount.Serialize());
 
         /// <inheritdoc cref="IAction.LoadPlainValue(IValue)"/>
-        public void LoadPlainValue(IValue plainValue)
+        public override void LoadPlainValue(IValue plainValue)
         {
             var dict = (Bencodex.Types.Dictionary)plainValue;
             Validator = dict["validator"].ToAddress();
             Amount = dict["amount"].ToFungibleAssetValue();
         }
 
         /// <inheritdoc cref="IAction.Execute(IActionContext)"/>
-        public IWorld Execute(IActionContext context)
+        public override IWorld Execute(IActionContext context)
         {
             IActionContext ctx = context;
             var states = ctx.PreviousState;

diff --git a/Lib9c/Action/DPoS/Sys/PromoteValidator.cs b/Lib9c/Action/DPoS/Sys/PromoteValidator.cs
@@ -15,7 +15,7 @@ namespace Nekoyume.Action.DPoS.Sys
     /// A system action for DPoS that promotes non-validator node to a validator.
     /// </summary>
     [ActionType(ActionTypeValue)]
-    public sealed class PromoteValidator : IAction
+    public sealed class PromoteValidator : ActionBase
     {
         private const string ActionTypeValue = "promote_validator";
 
@@ -50,21 +50,21 @@ public PromoteValidator()
         public FungibleAssetValue Amount { get; set; }
 
         /// <inheritdoc cref="IAction.PlainValue"/>
-        public IValue PlainValue => Bencodex.Types.Dictionary.Empty
+        public override IValue PlainValue => Bencodex.Types.Dictionary.Empty
             .Add("type_id", new Text(ActionTypeValue))
             .Add("validator", Validator.Serialize())
             .Add("amount", Amount.Serialize());
 
         /// <inheritdoc cref="IAction.LoadPlainValue(IValue)"/>
-        public void LoadPlainValue(IValue plainValue)
+        public override void LoadPlainValue(IValue plainValue)
         {
             var dict = (Bencodex.Types.Dictionary)plainValue;
             Validator = dict["validator"].ToPublicKey();
             Amount = dict["amount"].ToFungibleAssetValue();
         }
 
         /// <inheritdoc cref="IAction.Execute(IActionContext)"/>
-        public IWorld Execute(IActionContext context)
+        public override IWorld Execute(IActionContext context)
         {
             IActionContext ctx = context;
             if (!ctx.Signer.Equals(Validator.Address))

diff --git a/Lib9c/Action/DPoS/Sys/Redelegate.cs b/Lib9c/Action/DPoS/Sys/Redelegate.cs
@@ -15,7 +15,7 @@ namespace Nekoyume.Action.DPoS.Sys
     /// of shared tokens to <see cref="DstValidator"/> from <see cref="SrcValidator"/>.
     /// </summary>
     [ActionType(ActionTypeValue)]
-    public sealed class Redelegate : IAction
+    public sealed class Redelegate : ActionBase
     {
         private const string ActionTypeValue = "redelegate";
 
@@ -55,14 +55,14 @@ internal Redelegate()
         public FungibleAssetValue ShareAmount { get; set; }
 
         /// <inheritdoc cref="IAction.PlainValue"/>
-        public IValue PlainValue => Bencodex.Types.Dictionary.Empty
+        public override IValue PlainValue => Bencodex.Types.Dictionary.Empty
             .Add("type_id", new Text(ActionTypeValue))
             .Add("src", SrcValidator.Serialize())
             .Add("dst", DstValidator.Serialize())
             .Add("amount", ShareAmount.Serialize());
 
         /// <inheritdoc cref="IAction.LoadPlainValue(IValue)"/>
-        public void LoadPlainValue(IValue plainValue)
+        public override void LoadPlainValue(IValue plainValue)
         {
             var dict = (Bencodex.Types.Dictionary)plainValue;
             SrcValidator = dict["src"].ToAddress();
@@ -71,7 +71,7 @@ public void LoadPlainValue(IValue plainValue)
         }
 
         /// <inheritdoc cref="IAction.Execute(IActionContext)"/>
-        public IWorld Execute(IActionContext context)
+        public override IWorld Execute(IActionContext context)
         {
             IActionContext ctx = context;
             var states = ctx.PreviousState;

diff --git a/Lib9c/Action/DPoS/Sys/Undelegate.cs b/Lib9c/Action/DPoS/Sys/Undelegate.cs
@@ -15,7 +15,7 @@ namespace Nekoyume.Action.DPoS.Sys
     /// <see cref="ShareAmount"/> of shared tokens to a given <see cref="Validator"/>.
     /// </summary>
     [ActionType(ActionTypeValue)]
-    public sealed class Undelegate : IAction
+    public sealed class Undelegate : ActionBase
     {
         private const string ActionTypeValue = "undelegate";
 
@@ -47,21 +47,21 @@ internal Undelegate()
         public FungibleAssetValue ShareAmount { get; set; }
 
         /// <inheritdoc cref="IAction.PlainValue"/>
-        public IValue PlainValue => Bencodex.Types.Dictionary.Empty
+        public override IValue PlainValue => Bencodex.Types.Dictionary.Empty
             .Add("type_id", new Text(ActionTypeValue))
             .Add("validator", Validator.Serialize())
             .Add("amount", ShareAmount.Serialize());
 
         /// <inheritdoc cref="IAction.LoadPlainValue(IValue)"/>
-        public void LoadPlainValue(IValue plainValue)
+        public override void LoadPlainValue(IValue plainValue)
         {
             var dict = (Bencodex.Types.Dictionary)plainValue;
             Validator = dict["validator"].ToAddress();
             ShareAmount = dict["amount"].ToFungibleAssetValue();
         }
 
         /// <inheritdoc cref="IAction.Execute(IActionContext)"/>
-        public IWorld Execute(IActionContext context)
+        public override IWorld Execute(IActionContext context)
         {
             IActionContext ctx = context;
             var states = ctx.PreviousState;

diff --git a/Lib9c/Action/DPoS/Sys/WithdrawDelegator.cs b/Lib9c/Action/DPoS/Sys/WithdrawDelegator.cs
@@ -16,7 +16,7 @@ namespace Nekoyume.Action.DPoS.Sys
     /// A system action for DPoS that withdraws reward tokens from given <see cref="Validator"/>.
     /// </summary>
     [ActionType(ActionTypeValue)]
-    public sealed class WithdrawDelegator : IAction
+    public sealed class WithdrawDelegator : ActionBase
     {
         private const string ActionTypeValue = "withdraw_delegator";
 
@@ -41,18 +41,18 @@ public WithdrawDelegator()
         public Address Validator { get; set; }
 
         /// <inheritdoc cref="IAction.PlainValue"/>
-        public IValue PlainValue => Bencodex.Types.Dictionary.Empty
+        public override IValue PlainValue => Bencodex.Types.Dictionary.Empty
             .Add("type_id", new Text(ActionTypeValue))
             .Add("validator", Validator.Serialize());
 
         /// <inheritdoc cref="IAction.LoadPlainValue(IValue)"/>
-        public void LoadPlainValue(IValue plainValue)
+        public override void LoadPlainValue(IValue plainValue)
         {
             Validator = plainValue.ToAddress();
         }
 
         /// <inheritdoc cref="IAction.Execute(IActionContext)"/>
-        public IWorld Execute(IActionContext context)
+        public override IWorld Execute(IActionContext context)
         {
             IActionContext ctx = context;
             var states = ctx.PreviousState;