Merge pull request #508 from Unengine/add-randomextension

Remove `IActionContext.NewGuid()` & Add `RandomExtension.GenerateRandomGuid()`

CHANGES.md

@@ -58,6 +58,8 @@ To be released.
     `Swarm<T>.BootstrapAsync()` method instead.  [[#353]]
  -  `Peer` with endpoints should be typed as `BoundPeer` which is inherited from
     `Peer`.  [[#353]]
+ -  Removed `IActionContext.NewGuid()` method. To get a randomly generated [Guid][Guid],
+    use `RandomExtension.GenerateRandomGuid()` instead. [[#508]]
 
 ### Added interfaces
 
@@ -71,6 +73,7 @@ To be released.
     both a `Block<T>.Hash` and a `Transaction<T>.Id`, so that signers cannot
     predict the order of transactions in a block before it's mined.
     [[#244], [#355]]
+ -  Added `RandomExtension` static class. [[#508]]
 
 ### Behavioral changes
 
@@ -111,7 +114,9 @@ To be released.
 [#486]: https://github.com/planetarium/libplanet/pull/486
 [#498]: https://github.com/planetarium/libplanet/pull/498
 [#496]: https://github.com/planetarium/libplanet/pull/496
+[#508]: https://github.com/planetarium/libplanet/pull/508
 [Kademlia]: https://en.wikipedia.org/wiki/Kademlia
+[Guid]: https://docs.microsoft.com/ko-kr/dotnet/api/system.guid?view=netframework-4.8
 
 
 Version 0.5.3

Libplanet.Tests/Action/ActionContextTest.cs

@@ -72,9 +72,9 @@ public void GuidShouldBeDeterministic()
 
             foreach (var (expected, diff) in testCases)
             {
-                Assert.Equal(expected, context1.NewGuid());
-                Assert.Equal(expected, context2.NewGuid());
-                Assert.Equal(diff, context3.NewGuid());
+                Assert.Equal(expected, context1.Random.GenerateRandomGuid());
+                Assert.Equal(expected, context2.Random.GenerateRandomGuid());
+                Assert.Equal(diff, context3.Random.GenerateRandomGuid());
             }
         }
 

Libplanet/Action/ActionContext.cs

@@ -32,13 +32,5 @@ public ActionContext(
         public IAccountStateDelta PreviousStates { get; }
 
         public IRandom Random { get; }
-
-        public Guid NewGuid()
-        {
-            // FIXME implement rfc4122 https://www.ietf.org/rfc/rfc4122.txt
-            var b = new byte[16];
-            Random.NextBytes(b);
-            return new Guid(b);
-        }
     }
 }

Libplanet/Action/IActionContext.cs

@@ -55,12 +55,5 @@ public interface IActionContext
         /// <returns>A random object that shares interface mostly equivalent
         /// to <see cref="System.Random"/>.</returns>
         IRandom Random { get; }
-
-        /// <summary>
-        /// Creates new <see cref="Guid"/>.  Its seed (state) is determined by a block and
-        /// a transaction, which is deterministic as like <see cref="Random"/>.
-        /// </summary>
-        /// <returns>A deterministic guid.</returns>
-        Guid NewGuid();
     }
 }

Libplanet/Action/RandomExtension.cs

@@ -0,0 +1,27 @@
+using System;
+
+namespace Libplanet.Action
+{
+    /// <summary>
+    /// This extension class provides some convenient methods
+    /// to deal with <see cref="IRandom"/>.
+    /// </summary>
+    public static class RandomExtension
+    {
+        /// <summary>
+        /// Generates a random <see cref="Guid"/>.
+        /// </summary>
+        /// <param name="random"> <see cref="IRandom"/> to generate
+        /// a random <see cref="Guid"/>.</param>
+        /// <returns> Generated random <see cref="Guid"/>.
+        /// </returns>
+        /// <seealso cref="IRandom"/>
+        public static Guid GenerateRandomGuid(this IRandom random)
+        {
+            // FIXME implement rfc4122 https://www.ietf.org/rfc/rfc4122.txt
+            var bytes = new byte[16];
+            random.NextBytes(bytes);
+            return new Guid(bytes);
+        }
+    }
+}