Merge pull request #3934 from greymistcube/refactor/block-demand

♻️ Changed `BlockDemand` to hold an `IBlockExcerpt` instead of `BlockHeader`
planetarium · Aug 23, 2024 · 6ec04a5 · 6ec04a5
2 parents cb2deed + 8385be7
commit 6ec04a5
Show file tree

Hide file tree

Showing 4 changed files with 18 additions and 12 deletions.
diff --git a/CHANGES.md b/CHANGES.md
@@ -19,6 +19,8 @@ To be released.
     [[#3913]]
  -  (Libplanet.Store) Removed unused `HashNode.Serialize()` method.
     [[#3922], [#3924]]
+ -  (Libplanet.Net) Removed `Header` property and added `BlockExcerpt` property
+    to `BlockDemand`.  [[#3934]]
 
 ### Backward-incompatible network protocol changes
 
@@ -44,6 +46,7 @@ To be released.
 [#3922]: https://github.com/planetarium/libplanet/issues/3922
 [#3924]: https://github.com/planetarium/libplanet/pull/3924
 [#3926]: https://github.com/planetarium/libplanet/pull/3926
+[#3934]: https://github.com/planetarium/libplanet/pull/3934
 
 
 Version 5.2.2

diff --git a/src/Libplanet.Net/BlockDemand.cs b/src/Libplanet.Net/BlockDemand.cs
@@ -9,9 +9,9 @@ namespace Libplanet.Net
     public readonly struct BlockDemand : IBlockExcerpt
     {
         /// <summary>
-        /// The <see cref="BlockHeader"/> of the block to request.
+        /// The <see cref="IBlockExcerpt"/> of the block to request.
         /// </summary>
-        public readonly BlockHeader Header;
+        public readonly IBlockExcerpt BlockExcerpt;
 
         /// <summary>
         /// The <see cref="BoundPeer"/> to request block hash from.
@@ -24,17 +24,20 @@ namespace Libplanet.Net
         /// </summary>
         public readonly DateTimeOffset Timestamp;
 
-        public BlockDemand(BlockHeader header, BoundPeer peer, DateTimeOffset timestamp)
+        public BlockDemand(IBlockExcerpt blockExcerpt, BoundPeer peer, DateTimeOffset timestamp)
         {
-            Header = header;
+            BlockExcerpt = blockExcerpt;
             Peer = peer;
             Timestamp = timestamp;
         }
 
-        public int ProtocolVersion => Header.ProtocolVersion;
+        /// <inheritdoc cref="IBlockExcerpt.ProtocolVersion"/>
+        public int ProtocolVersion => BlockExcerpt.ProtocolVersion;
 
-        public long Index => Header.Index;
+        /// <inheritdoc cref="IBlockExcerpt.Index"/>
+        public long Index => BlockExcerpt.Index;
 
-        public BlockHash Hash => ((IBlockExcerpt)Header).Hash;
+        /// <inheritdoc cref="IBlockExcerpt.Hash"/>
+        public BlockHash Hash => BlockExcerpt.Hash;
     }
 }
diff --git a/src/Libplanet.Net/BlockDemandTable.cs b/src/Libplanet.Net/BlockDemandTable.cs
@@ -33,7 +33,7 @@ public void Add(
             {
                 _blockDemands[demand.Peer] = demand;
                 Log.Debug(
-                    "BlockDemand #{Index} {BlockHash} from peer {Peer} added",
+                    "BlockDemand #{Index} {BlockHash} from peer {Peer} updated",
                     demand.Index,
                     demand.Hash,
                     demand.Peer);

diff --git a/src/Libplanet.Net/Swarm.BlockCandidate.cs b/src/Libplanet.Net/Swarm.BlockCandidate.cs
@@ -365,8 +365,8 @@ private async Task<bool> ProcessBlockDemandAsync(
                 "to fetch the block #{BlockIndex} {BlockHash} at {MethodName}()",
                 sessionId,
                 peer,
-                demand.Header.Index,
-                demand.Header.Hash,
+                demand.Index,
+                demand.Hash,
                 nameof(ProcessBlockDemandAsync));
 
             try
@@ -375,7 +375,7 @@ private async Task<bool> ProcessBlockDemandAsync(
                 var result = await BlockCandidateDownload(
                     peer: peer,
                     blockChain: BlockChain,
-                    stop: demand.Header,
+                    stop: demand.BlockExcerpt,
                     logSessionId: sessionId,
                     cancellationToken: cancellationToken);
 
@@ -431,7 +431,7 @@ private async Task<bool> ProcessBlockDemandAsync(
         private async Task<bool> BlockCandidateDownload(
             BoundPeer peer,
             BlockChain blockChain,
-            BlockHeader stop,
+            IBlockExcerpt stop,
             int logSessionId,
             CancellationToken cancellationToken)
         {