Make block hash/tx sig independent from locale

planetarium · Dec 17, 2019 · 661dff5 · 661dff5
1 parent 1db7583
commit 661dff5
Show file tree

Hide file tree

Showing 5 changed files with 36 additions and 6 deletions.
diff --git a/CHANGES.md b/CHANGES.md
@@ -95,6 +95,14 @@ To be released.
  -  Fixed a bug where `BlockChain<T>.GetNextTxNonce()` had returned invalid tx
     nonce.  [[#718]]
  -  Fixed a bug where mined transactions were staged again.  [[#719]]
+ -  Fixed a bug where `Block<T>.Hash` property, `Block<T>.Mine()` method,
+    `Block<T>.FromBencodex()` method, `Block<T>.ToBencodex()` method,
+    `Transaction<T>.Id` property, `Transaction<T>.Signature` property,
+    `Transaction<T>.Create()` method, `Transaction<T>.FromBencodex()` method,
+    and `Transaction<T>.ToBencodex()` method had been non-deterministic on
+    some `CultureInfo.CurrentCulture` (e.g., `ar_SA`, `fr_FR`, `th_TH`)
+    so that it had caused network protocol incompatibilities.
+    [[#734]]
 
 [#604]: https://github.com/planetarium/libplanet/issues/604
 [#613]: https://github.com/planetarium/libplanet/issues/613
@@ -117,8 +125,9 @@ To be released.
 [#718]: https://github.com/planetarium/libplanet/pull/718
 [#719]: https://github.com/planetarium/libplanet/pull/719
 [#725]: https://github.com/planetarium/libplanet/pull/725
-[#726]: https://github.com/planetarium/libplanet/pull/726
-[#727]: https://github.com/planetarium/libplanet/pull/727
+[#726]: https://github.com/planetarium/libplanet/pull/72
+[#727]: https://github.com/planetarium/libplanet/pull/7276
+[#734]: https://github.com/planetarium/libplanet/pull/734
 
 
 Version 0.7.0

diff --git a/Libplanet.Tests/Common/Action/DumbAction.cs b/Libplanet.Tests/Common/Action/DumbAction.cs
@@ -1,6 +1,7 @@
 using System;
 using System.Collections.Generic;
 using System.Collections.Immutable;
+using System.Globalization;
 using System.Linq;
 using System.Threading;
 using Bencodex.Types;
@@ -112,7 +113,16 @@ public IAccountStateDelta Execute(IActionContext context)
             if (Idempotent)
             {
                 var splitedItems = items is null ? new[] { item } : (items + "," + item).Split(',');
-                items = string.Join(",", splitedItems.OrderBy(x => float.Parse(x.Substring(4))));
+                items = string.Join(
+                    ",",
+                    splitedItems.OrderBy(x =>
+                        float.Parse(
+                            x.Substring(4),
+                            NumberStyles.Float,
+                            CultureInfo.InvariantCulture
+                        )
+                    )
+                );
             }
             else
             {

diff --git a/Libplanet/Action/IAction.cs b/Libplanet/Action/IAction.cs
@@ -269,10 +269,21 @@ public interface IAction
         /// or networking.  These bring an action indeterministic.  You maybe
         /// fine to log messages for debugging purpose, but equivalent messages
         /// could be logged multiple times.</para>
-        /// <para>Lastly, although it might be surprising, <a
+        /// <para>Although it might be surprising, <a
         /// href="https://wp.me/p1fTCO-kT">floating-point arithmetics are
         /// underspecified so that it can make different results on different
         /// machines, platforms, runtimes, compilers, and builds</a>.</para>
+        /// <para>Lastly, you need to be aware and keep in mind that there
+        /// is a global state named <see
+        /// cref="System.Globalization.CultureInfo.CurrentCulture"/> on .NET;
+        /// if you format numbers, dates and times, currencies, or other such
+        /// things into strings and parse these strings back these can rely on
+        /// <see cref="System.Globalization.CultureInfo.CurrentCulture"/>,
+        /// so that the same action make different results on two differently
+        /// configured systems like Thai language and French language.
+        /// In order to make these types of conversions deterministic,
+        /// you have to explicitly pass <see
+        /// cref="System.Globalization.CultureInfo.InvariantCulture"/>.</para>
         /// <para>For more on determinism in general, please read also <a
         /// href="https://tendermint.com/docs/spec/abci/abci.html#determinism"
         /// >Tendermint ABCI's docs on determinism</a>.</para>

diff --git a/Libplanet/Blocks/Block.cs b/Libplanet/Blocks/Block.cs
@@ -485,7 +485,7 @@ bool includeTransactionData
                 );
             var rawBlock = new RawBlock(
                 index: Index,
-                timestamp: Timestamp.ToString(TimestampFormat),
+                timestamp: Timestamp.ToString(TimestampFormat, CultureInfo.InvariantCulture),
                 nonce: Nonce.ToByteArray(),
                 miner: Miner?.ToByteArray(),
                 difficulty: Difficulty,

diff --git a/Libplanet/Tx/Transaction.cs b/Libplanet/Tx/Transaction.cs
@@ -665,7 +665,7 @@ internal RawTransaction ToRawTransaction(bool includeSign)
                 updatedAddresses: UpdatedAddresses.Select(a =>
                     a.ByteArray).ToImmutableArray(),
                 publicKey: PublicKey.Format(false).ToImmutableArray(),
-                timestamp: Timestamp.ToString(TimestampFormat),
+                timestamp: Timestamp.ToString(TimestampFormat, CultureInfo.InvariantCulture),
                 actions: Actions.Select(a => a.PlainValue)
             );