chore: Minor fixes and add docstrings for new actions

planetarium · Nov 26, 2024 · 8650fc7 · 8650fc7
1 parent 31c7167
commit 8650fc7
Show file tree

Hide file tree

Showing 8 changed files with 20 additions and 1 deletion.
diff --git a/Lib9c/Action/Guild/Migration/GuildMigrationFailedException.cs b/Lib9c/Action/Guild/Migration/GuildMigrationFailedException.cs
@@ -2,6 +2,9 @@
 
 namespace Nekoyume.Action.Guild.Migration
 {
+    /// <summary>
+    /// An exception to be thrown when guild migration failed.
+    /// </summary>
     public class GuildMigrationFailedException : InvalidOperationException
     {
         public GuildMigrationFailedException(string message) : base(message)

diff --git a/Lib9c/Action/Guild/Migration/LegacyModels/LegacyGuild.cs b/Lib9c/Action/Guild/Migration/LegacyModels/LegacyGuild.cs
@@ -6,6 +6,9 @@
 namespace Nekoyume.Action.Guild.Migration.LegacyModels
 {
     // TODO: [GuildMigration] Remove this class when the migration is done.
+    /// <summary>
+    /// The legacy model for Guild.
+    /// </summary>
     public class LegacyGuild : IEquatable<LegacyGuild>, IBencodable
     {
         private const string StateTypeName = "guild";

diff --git a/Lib9c/Action/Guild/Migration/LegacyModels/LegacyGuildParticipant.cs b/Lib9c/Action/Guild/Migration/LegacyModels/LegacyGuildParticipant.cs
@@ -6,6 +6,9 @@
 namespace Nekoyume.Action.Guild.Migration.LegacyModels
 {
     // TODO: [GuildMigration] Remove this class when the migration is done.
+    /// <summary>
+    /// The legacy model for GuildParticipant.
+    /// </summary>
     public class LegacyGuildParticipant : IBencodable, IEquatable<LegacyGuildParticipant>
     {
         private const string StateTypeName = "guild_participant";

diff --git a/Lib9c/Action/Guild/Migration/LegacyModels/MigrationModule.cs b/Lib9c/Action/Guild/Migration/LegacyModels/MigrationModule.cs
@@ -5,6 +5,10 @@
 
 namespace Nekoyume.Action.Guild.Migration.LegacyModels
 {
+    // TODO: [GuildMigration] Remove this class when the migration is done.
+    /// <summary>
+    /// The module for delegation height for migration.
+    /// </summary>
     public static class MigrationModule
     {
         /// <summary>

diff --git a/Lib9c/Action/Guild/Migration/MigrateDelegation.cs b/Lib9c/Action/Guild/Migration/MigrateDelegation.cs
@@ -17,6 +17,8 @@ namespace Nekoyume.Action.Guild.Migration
     // TODO: [GuildMigration] Remove this class when the migration is done.
     /// <summary>
     /// An action to migrate guild delegation.
+    /// After migration is done, guild participant now have delegation with
+    /// validator.
     /// </summary>
     [ActionType(TypeIdentifier)]
     public class MigrateDelegation : ActionBase

diff --git a/Lib9c/Action/Guild/Migration/MigrateDelegationHeight.cs b/Lib9c/Action/Guild/Migration/MigrateDelegationHeight.cs
@@ -10,6 +10,7 @@ namespace Nekoyume.Action.Guild.Migration
     // TODO: [GuildMigration] Remove this class when the migration is done.
     /// <summary>
     /// An action to migrate the delegation height.
+    /// This action triggers the migration of the delegation height.
     /// </summary>
     [ActionType(TypeIdentifier)]
     public class MigrateDelegationHeight : ActionBase

diff --git a/Lib9c/Action/Guild/Migration/MigratePlanetariumGuild.cs b/Lib9c/Action/Guild/Migration/MigratePlanetariumGuild.cs
@@ -12,6 +12,7 @@ namespace Nekoyume.Action.Guild.Migration
     // TODO: [GuildMigration] Remove this class when the migration is done.
     /// <summary>
     /// An action to migrate the planetarium guild.
+    /// After migration, the planetarium guild now has a validator to delegate.
     /// </summary>
     [ActionType(TypeIdentifier)]
     public class MigratePlanetariumGuild : ActionBase

diff --git a/Lib9c/Action/Guild/Migration/MigratePlanetariumValidator.cs b/Lib9c/Action/Guild/Migration/MigratePlanetariumValidator.cs
@@ -10,7 +10,9 @@ namespace Nekoyume.Action.Guild.Migration
 {
     // TODO: [GuildMigration] Remove this class when the migration is done.
     /// <summary>
-    /// An action to migrate the planetarium guild.
+    /// An action to migrate the planetarium validator.
+    /// With this migration, planetarium validator is now active,
+    /// and bonded FAVs are moved to active address.
     /// </summary>
     [ActionType(TypeIdentifier)]
     public class MigratePlanetariumValidator : ActionBase