feat: make IVoteMetadata.ValidatorPower nullable (skip changelog)

limebell · Jun 10, 2024 · d251ea8 · d251ea8
1 parent ce8f7ec
commit d251ea8
Show file tree

Hide file tree

Showing 4 changed files with 19 additions and 9 deletions.
diff --git a/Libplanet.Explorer/GraphTypes/VoteType.cs b/Libplanet.Explorer/GraphTypes/VoteType.cs
@@ -30,7 +30,7 @@ public VoteType()
                 "ValidatorPublicKey",
                 description: "Public key of the validator which is subject of the vote.",
                 resolve: ctx => ctx.Source.ValidatorPublicKey);
-            Field<NonNullGraphType<BigIntGraphType>>(
+            Field<BigIntGraphType>(
                 "ValidatorPower",
                 description: "Power of the validator which is subject of the vote.",
                 resolve: ctx => ctx.Source.ValidatorPower);

diff --git a/Libplanet.Types/Consensus/IVoteMetadata.cs b/Libplanet.Types/Consensus/IVoteMetadata.cs
@@ -38,8 +38,10 @@ public interface IVoteMetadata
 
         /// <summary>
         /// The voting power of the validator that voted.
+        /// If null, the vote is legacy thus <see cref="ValidatorPower"/>
+        /// is not included in signature.
         /// </summary>
-        BigInteger ValidatorPower { get; }
+        BigInteger? ValidatorPower { get; }
 
         /// <summary>
         /// The <see cref="VoteFlag"/> indicating the type of a <see cref="Vote"/>.

diff --git a/Libplanet.Types/Consensus/Vote.cs b/Libplanet.Types/Consensus/Vote.cs
@@ -103,7 +103,7 @@ private Vote(Bencodex.Types.Dictionary encoded)
         public PublicKey ValidatorPublicKey => _metadata.ValidatorPublicKey;
 
         /// <inheritdoc/>
-        public BigInteger ValidatorPower => _metadata.ValidatorPower;
+        public BigInteger? ValidatorPower => _metadata.ValidatorPower;
 
         /// <inheritdoc/>
         public VoteFlag Flag => _metadata.Flag;

diff --git a/Libplanet.Types/Consensus/VoteMetadata.cs b/Libplanet.Types/Consensus/VoteMetadata.cs
@@ -49,7 +49,9 @@ public class VoteMetadata : IVoteMetadata, IEquatable<VoteMetadata>, IBencodable
         /// <param name="validatorPublicKey">
         /// <see cref="PublicKey"/> of the validator made the vote.
         /// </param>
-        /// <param name="validatorPower">The voting power of the validator.</param>
+        /// <param name="validatorPower">The voting power of the validator.
+        /// If null is given, the vote is legacy thus <see cref="IVoteMetadata.ValidatorPower"/>
+        /// is not included in signature.</param>
         /// <param name="flag"><see cref="VoteFlag"/> for the vote's status.</param>
         /// <exception cref="ArgumentException">Thrown for any of the following reasons:
         /// <list type="bullet">
@@ -69,7 +71,7 @@ public VoteMetadata(
             BlockHash blockHash,
             DateTimeOffset timestamp,
             PublicKey validatorPublicKey,
-            BigInteger validatorPower,
+            BigInteger? validatorPower,
             VoteFlag flag)
         {
             if (height < 0)
@@ -82,7 +84,7 @@ public VoteMetadata(
                 throw new ArgumentException(
                     $"Given {nameof(round)} cannot be negative: {round}");
             }
-            else if (validatorPower <= 0)
+            else if (validatorPower is { } power && power <= 0)
             {
                 var msg = $"Given {nameof(validatorPower)} cannot be negative " +
                           $"or equal to zero: {validatorPower}";
@@ -127,7 +129,9 @@ private VoteMetadata(Bencodex.Types.Dictionary bencoded)
                     CultureInfo.InvariantCulture),
                 validatorPublicKey: new PublicKey(
                     ((Binary)bencoded[ValidatorPublicKeyKey]).ByteArray),
-                validatorPower: (Integer)bencoded[ValidatorPowerKey],
+                validatorPower: bencoded.ContainsKey(ValidatorPowerKey)
+                    ? (Integer)bencoded[ValidatorPowerKey]
+                    : (Integer)(-1),
                 flag: (VoteFlag)(int)(Integer)bencoded[FlagKey])
         {
         }
@@ -149,7 +153,7 @@ private VoteMetadata(Bencodex.Types.Dictionary bencoded)
         public PublicKey ValidatorPublicKey { get; }
 
         /// <inheritdoc/>
-        public BigInteger ValidatorPower { get; }
+        public BigInteger? ValidatorPower { get; }
 
         /// <inheritdoc/>
         public VoteFlag Flag { get; }
@@ -167,14 +171,18 @@ public Bencodex.Types.IValue Bencoded
                         TimestampKey,
                         Timestamp.ToString(TimestampFormat, CultureInfo.InvariantCulture))
                     .Add(ValidatorPublicKeyKey, ValidatorPublicKey.Format(compress: true))
-                    .Add(ValidatorPowerKey, ValidatorPower)
                     .Add(FlagKey, (long)Flag);
 
                 if (BlockHash is { } blockHash)
                 {
                     encoded = encoded.Add(BlockHashKey, blockHash.ByteArray);
                 }
 
+                if (ValidatorPower is { } power)
+                {
+                    encoded = encoded.Add(ValidatorPowerKey, power);
+                }
+
                 return encoded;
             }
         }