Bundle finalization (#261)

* Repeat finalization until normalized bundle hash contains no 13

* Fix finalization of empty bundles

* Fix bundle finalization test

* Include <algorithm>

Author: thibault-martinez

include/iota/types/trinary.hpp

@@ -149,6 +149,13 @@ tritsToInt(const Trits& trits) {
   return res;
 }
 
+/**
+ * Increments the specified trits.
+ *
+ * @param trits The trits.
+ */
+void incrementTrits(Trits& trits);
+
 }  // namespace Types
 
 }  // namespace IOTA

source/models/bundle.cpp

@@ -23,6 +23,8 @@
 //
 //
 
+#include <algorithm>
+
 #include <iota/constants.hpp>
 #include <iota/crypto/kerl.hpp>
 #include <iota/models/bundle.hpp>
@@ -90,33 +92,46 @@ Bundle::addTransaction(const Transaction& transaction, int32_t signatureMessageL
 void
 Bundle::finalize() {
   Crypto::Kerl k;
+  bool         validBundle = false;
+
+  while (!validBundle) {
+    k.reset();
+    for (std::size_t i = 0; i < transactions_.size(); i++) {
+      auto& trx = transactions_[i];
+
+      trx.setCurrentIndex(i);
+      trx.setLastIndex(transactions_.size() - 1);
+
+      auto value = Types::tritsToTrytes(Types::intToTrits(trx.getValue(), SeedLength));
+      auto timestamp =
+          Types::tritsToTrytes(Types::intToTrits(trx.getTimestamp(), TryteAlphabetLength));
+      auto currentIndex =
+          Types::tritsToTrytes(Types::intToTrits(trx.getCurrentIndex(), TryteAlphabetLength));
+      auto lastIndexTrits =
+          Types::tritsToTrytes(Types::intToTrits(trx.getLastIndex(), TryteAlphabetLength));
+
+      auto bytes = Types::trytesToBytes(trx.getAddress().toTrytes() + value +
+                                        trx.getObsoleteTag().toTrytesWithPadding() + timestamp +
+                                        currentIndex + lastIndexTrits);
+      k.absorb(bytes);
+    }
 
-  for (std::size_t i = 0; i < transactions_.size(); i++) {
-    auto& trx = transactions_[i];
-
-    trx.setCurrentIndex(i);
-    trx.setLastIndex(transactions_.size() - 1);
-
-    auto value = Types::tritsToTrytes(Types::intToTrits(trx.getValue(), SeedLength));
-    auto timestamp =
-        Types::tritsToTrytes(Types::intToTrits(trx.getTimestamp(), TryteAlphabetLength));
-    auto currentIndex =
-        Types::tritsToTrytes(Types::intToTrits(trx.getCurrentIndex(), TryteAlphabetLength));
-    auto lastIndexTrits =
-        Types::tritsToTrytes(Types::intToTrits(trx.getLastIndex(), TryteAlphabetLength));
-
-    auto bytes = Types::trytesToBytes(trx.getAddress().toTrytes() + value +
-                                      trx.getTag().toTrytesWithPadding() + timestamp +
-                                      currentIndex + lastIndexTrits);
-
-    k.absorb(bytes);
+    std::vector<uint8_t> hash(ByteHashLength);
+    k.finalSqueeze(hash);
+
+    //! set bundle hash for each underlying transaction
+    hash_               = Types::bytesToTrytes(hash);
+    auto normalizedHash = normalizedBundle(hash_);
+    if (transactions_.size() != 0 && std::find(std::begin(normalizedHash), std::end(normalizedHash),
+                                               13 /* = M */) != std::end(normalizedHash)) {
+      // Insecure bundle. Increment Tag and recompute bundle hash.
+      auto tagTrits = Types::trytesToTrits(transactions_[0].getObsoleteTag().toTrytesWithPadding());
+      Types::incrementTrits(tagTrits);
+      transactions_[0].setObsoleteTag(Types::tritsToTrytes(tagTrits));
+    } else {
+      validBundle = true;
+    }
   }
-
-  std::vector<uint8_t> hash(ByteHashLength);
-  k.finalSqueeze(hash);
-
-  //! set bundle hash for each underlying transaction
-  hash_ = Types::bytesToTrytes(hash);
   for (std::size_t i = 0; i < transactions_.size(); i++) {
     transactions_[i].setBundle(hash_);
   }

source/types/trinary.cpp

@@ -187,14 +187,14 @@ tritsToTrytes(const Trits& trits, std::size_t length) {
   return trytes;
 }
 
-Types::Trits
+Trits
 intToTrits(const int64_t& value) {
   if (value == 0)
     return {};
 
-  Types::Trits trits;
-  int          sign          = (value > 0) - (value < 0);
-  uint64_t     absoluteValue = value * sign;
+  Trits    trits;
+  int      sign          = (value > 0) - (value < 0);
+  uint64_t absoluteValue = value * sign;
 
   // pre-computed log3(e)
   static const double log3e = 0.91023922662683739361;
@@ -217,7 +217,7 @@ intToTrits(const int64_t& value) {
   return trits;
 }
 
-Types::Trits
+Trits
 intToTrits(const int64_t& value, std::size_t length) {
   auto res = intToTrits(value);
 
@@ -226,6 +226,17 @@ intToTrits(const int64_t& value, std::size_t length) {
   return res;
 }
 
+void
+incrementTrits(Trits& trits) {
+  for (unsigned int i = 0; i < trits.size(); ++i) {
+    if (++trits[i] > 1) {
+      trits[i] = -1;
+    } else {
+      break;
+    }
+  }
+}
+
 }  // namespace Types
 
 }  // namespace IOTA

test/source/models/bundle_test.cpp

@@ -219,81 +219,15 @@ TEST(Bundle, GtOperator) {
 TEST(Bundle, Finalize) {
   IOTA::Models::Bundle b;
 
-  b.addTransaction(
-      { "RGGVEMTBJIZEES9AWZTCMIQPAKJZ9JYDZBZCWCUGQPFMHCMAUXNFRSHLIKELNPUYTIPMJQKDJQVORVHWWBFZQRYWGZ"
-        "OVVRBJPOFDDJKHICAFQEWZH9XGLYZGPYNHOQMGCIOP9GLUTHPCEZHWRYAPOYLKRZLSAMXNLCAWSMCVBTJOUBPDJXZL"
-        "MQKRW9HHTFOOFHZKE9SNXBNPLKNWXABPZFOSPDCZPXVHQRXYFWSUAGLIVJJQABUWKNZWPURHNQMVXBMWYWXKJBOWBD"
-        "KHFMQNBSI9JWMMBRFAJJPGIVMOELGT9EPYLSODUMLCNWBIDWSRHVDFLYAPORAUUOESG9JTFXFDRFVIZMNUJFIKSJTR"
-        "QRMTBTYKK9DGEGSZMVNRNBLWXJJUZHEHK9GNVSXEATUAOOBSTGKEVLGZBNROMZOUDVBEJYFCIDOCQMNJPIXMVFEB9O"
-        "SYJGNNJACNQEFS9LITZENJUEFUMMONVPPLVOPISNIZNOILKTU9SGMWKBZLQVERKFAMJEOQQOTAVSJMTLY9JSWKFPFI"
-        "HMRWMWZ9OWJKNKIIVGEMHAMLTQPRE9UQKZIPT9VXJTN9CGUGGNRBGNOVYBX9QPCHR9LNLIGSWREHDPNWAQP9TEOEKP"
-        "ICMPDJQZCGPNSQERKOQJUJJDEQCQILQOOKFHJNDUJMDYZWLDTLUTYWHDLGGPHUVMOAJZRXWGXONTDEMIYVRCBJVDXH"
-        "TGF9LRWHDDOHEVGQLWPXLPXMCYOZQBSFLNOEHBUORDUSBFYJPCLFSRKOTNMEUQCMYKHHRBJFNNWA9TSRXLPVYIAJOL"
-        "PKAKIAJYXYSIUKYMEYTZXTBIUJBXEHIOBHANMNDYBCDSBQQSBYKAIEU9OXMIYRGGRXYYEGXB99STNHOQDPK9MCMZBL"
-        "ZEMKCFOSOTVNULCHGTCIFTFFLXACQPUVPH9ADV9GUZZTPBJJYVUHKDLUUSAHWNZNGTRRUIAUKNHNIBNZRXBFRFEVNL"
-        "KUYDUQUCKXOTVYTHCLGVGPTWX9ZHOSGEYLNGNOJUQPSDI9KNEYWIOSJPVTZMIK9FUUKRSYFQZJCZVWBACAWRCZZBCV"
-        "CXQANNFHNIFZACTRBTIOHWTNTTFCACGDSMGZFDCBRYCYOMZXTKOCWATJRPRCIAWWHQIIOPLTTKISZXQJDYSCVEZCWG"
-        "GXKKEBJAIHXPOYYCARKBSWMMKHVSXPHGWKNKQPEADI9CX9HCEVINXITKIOJVPBTGRJWDZI9LYDPXVLGTMBHNFIROHQ"
-        "RRVNBBZVMNCCVGZW9OXHKQNLLPMTQGFEGLSYIOFJGXZ9SPYWIVZEZYIRAMROSWYZUIIUJVVPXVAONMOCYJJBKMQUO9"
-        "OBBJXFNESYQXNWULUDSAWNBZOOGWQSUXZFMNRWCZGHT9KCIJPWYWXBNDYXGLGDDELQHYBFGVTTCJEIVYEJDCKRAECH"
-        "CHPCGVSRJZJSDEATRIFOQXF9YMVQFSARZFQUGUSVKMUP9GNBTPRROTSZIEWXHPCBQYAUOXKFOZWDBKUFCKXNXMFZGV"
-        "UEKCCLRWFBAKROVAVPNNRFYPEWBNXTWVGLZMOWAIEF9WOCGXZCVQXWFLUYAKFBRLABYUHNMBCAAFVADSPPOCKQXHTA"
-        "KQLSOWPLFRVCNUQNNRLGKRFUARWJXGEABPIJWQX9TFQNPOSZZQPYDTNXDIBXVWQPYQDGPLXHXKQKGI9EAFQUFXMONE"
-        "JXRFZMHJSDYBXHSBVBZCOZVNFQQKEISCOSYLWH9WTRSJYRBQJGUQQVBAUBNWYBIPZZQHMIUPHBTKIVXQ9DONMSWLRT"
-        "EGWSUNSZWXWGUXG9YFXUHOKOJRMWNRXOYINKEJFZDOFENGSCFBJYNKBTZLDXYTPYYXYBWGZLATTFQYEDZRQMRROBGX"
-        "HGGZXSCFR9SEDBQRMKXQXJETMJJMWGTUBBKARMZAUSENUCTRYOBTKISTSEPRPDXEPQ99HGAKOCXJN9PGKJVMMGITIU"
-        "IIMFIQSYGIJ9I9JPVSPICRHPCXVRIZNTVQQSVTJZXEIHYXMOXDEFKDQBOEERRAWBRLNWUHJANYBXLIMOC9FNKUBXFC"
-        "QXXPKOSMGPLZJHAYQV9LFNLVKSPGLIBPYACKKWHYIOFBUUJVEQQUJJFRSXWCTEVUNLKLMYGMSOCXCDAKSIOFKDWHQK"
-        "OOCCHHYNTZLE99BQZ9VLCSML9RB",
-        0, 1, "999999999999999999999999999999999999999999999999999999NFRPTDAX9XUSPAQBPVPFXF99EA9",
-        "BIGFB9ABABLWWIRSYRDVFRVURZJLDCMOUGYYGNSKQ9JSLXGHXKZPCBMCEMFUIP9UMGRBIVVDQIHDZ9999",
-        1507233573,
-        "HYZJPVGLNYMHKMC9TRQXNXSSHZZUOUBZRJMLZETENPQKTIECOSG9CFLNVWNMSPXQGCHMTZT9OCR9A9999",
-        "KTRETJZQNAZKOLFKJGQUYLSYVHTFJBE9MZCUOAWZXTFOHWMMZBPOFVGQCRSASCBKDQZRIXNILUZQ99999",
-        "KPWCHICGJZXKE9GSUDXZYUAPLHAKAHYHDXNPHENTERYMMBQOPSQIDENXKLKCEYCPVTZQLEEJVYJZV9BWU", 0, "",
-        "MNPL99999999999999999999999", 0, 0, 0 });
-
-  b.addTransaction(
-      { "BUZYVXO9XB99HAXGWEVDAAYDIUVINLZVQWGMGYMANUCVXFPQV9OAOBEPXBRYIKMUSGTCFZUSXTNNOELBBMRJ"
-        "QXGLCYGUWBZVNOGPCLFJLMKIWXTTQBICGWJVHPLJWYJXUFUWRWMRWWZHCTXNYJFYTQNAWPSRYPI9LOPZRVFM"
-        "ADJFQQ9BZUBKLMJLZSBSBFPWLUKJYZHTPCTJNALXTGSHHUZKNNIYREZOESRNFO9GFNPPNVUZ9KABTIYIALFI"
-        "OLJYSUPQPFELKLZKBRZQXFEXIEGKZUMOAYCUQQOXELMOQJIFPCKDKVBJ9IZSTMBIPF9OMGXINNUFPVRNXLDC"
-        "OQZOARW9DJFANYZXSZXMAWCOPHOY9XYCLNJRZRUHKHLPLHKWFPZWPSIWIWKZXZVSMGEIBSAULAGCSSVJZHNB"
-        "THUCXIXXJPLFFE9ZEJPCLMIYKQCHTVRZPZELVGJAWMAHVDMUFKJHXLEWZWXQRYEPENVKPGMYNIGVQYJVQBYC"
-        "PNDRSHYJV9HHKVCGKF99OZEBNLMQSPEJKPYDTYBUANSUMQDSCNGKKZKVSQFTO9LFKEUPWGAGYOJKTHPOAHJM"
-        "RASHGDELFYSG9XDF9OYGMDYTCUMMOLUYMPC9FDPPKHLYZTMMFHZDPCWYBGMKVEOUXXOPN9RTQPOVETCHZHWG"
-        "QZMADCXEVGTWXY9LBZBPYUMPQHOGWHRWK9XDOMDJAAZRSOOIYSWUVBXTVJWJBVNVPFEWEJZUJCKBEHBOGKZH"
-        "ZE9COE9BDVGAMCJQDQZAFRWOFYXVUSIAJQSOC9SI9SEQGCKPGCXFXYSJNHTMHTXCRVYNPVSDYEUTHFYUAIKA"
-        "PTMQLPXIGZHWO9BFZNOZC9VBJAVTJCUESQJDMBETBIZODVHZDSWQDOUIPCYTZCGOPMJJIDOTYPAMTTEXLVZ9"
-        "CTARGVHAIQODWUHKEX9IDDD9HNBNYRVGI9LARZKMSTAJIHZWPPIAGTLFTPRAIJUFYYXTIJJZW9UEFJKQCKXW"
-        "STKP9CSMXHCRCECZDBRHIABBIQEBYWNPFHXFFAYEOLDAHFOCVK9AAKF9EQLNFSDEORKFYXKUXSGSTQMBVRNI"
-        "BOGUWYNJISWGTZRUBAUPSACRTWPAQIDXOXUXMKEVCDZLBUXWINABWYBDMZNIYNVPYLRKUULTMNNKZUFNQOQK"
-        "ROJSXWYTBRDSJQKTOUXLMXVCVIXEYPZWBSMEXMBGUIVACRTGKDEIYZKP9KQCQXPWRXNLGQOATRHCXJFQINXF"
-        "YQIDTPUJVXKUYVRYHWDHWSNLWUFPNNJZVNMRFWPZBJCRRSHMHUG9NKKH9SOXTUJUAXBF9MHYWHJ9ZTJRUQFK"
-        "RLHMNVPWX9XFXLMVJAGASMWMIFYUZFAUCEIOOYMEYWOIZTNEWFVZKOQFECWEPSMOYFSJJKEJQMPSXGE9WTYR"
-        "QJVMHUQZFD9MJUFFCNSGAZCTXYPIJFNSXAUCYPGZMNWMQWSWCKAQYKXJTWINSGPPZG9HLDLEAWUWEVCTVRCB"
-        "DFOXKUROXH9HXXAXVPEJFRSLOGRVGYZASTEBAQNXJJROCYRTDPYFUIQJVDHAKEG9YACV9HCPJUEUKOYFNWDX"
-        "CCJBIFQKYOXGRDHVTHEQUMHO999999999999999999999999999999999999999999999999999999999999"
-        "999999999999999999999999999999999999999999999999999999999999999999999999999999999999"
-        "999999999999999999999999999999999999999999999999999999999999999999999999999999999999"
-        "999999999999999999999999999999999999999999999999999999999999999999999999999999999999"
-        "999999999999999999999999999999999999999999999999999999999999999999999999999999999999"
-        "999999999999999999999999999999999999999999999999999999999999999999999999999999999999"
-        "999999999999999999999999999999999999999999999999999999999999999999999999999999999999"
-        "999",
-        1, 1, "999999999999999999999999999999999999999999999999999999OVATEWFUX9ORCXAETEZCEJZVOXG",
-        "HYZJPVGLNYMHKMC9TRQXNXSSHZZUOUBZRJMLZETENPQKTIECOSG9CFLNVWNMSPXQGCHMTZT9OCR9A9999",
-        1507233573,
-        "KTRETJZQNAZKOLFKJGQUYLSYVHTFJBE9MZCUOAWZXTFOHWMMZBPOFVGQCRSASCBKDQZRIXNILUZQ99999",
-        "UXWJUGEJFXZGOKZUOLVIUWBKYXWAQBDUMZYLTJUBRFXUWAY9DZHVHXCOYAJKLFOBXYOPLIBHIHQV99999",
-        "999999999999999999999999999999999999999999999999999999999999999999999999999999999", 0, "",
-        "999999999999999999999999999", 0, 0, 0 });
+  b.addTransaction(IOTA::Models::Transaction(BUNDLE_1_TRX_1_TRYTES));
+  b.addTransaction(IOTA::Models::Transaction(BUNDLE_1_TRX_2_TRYTES));
+  b.addTransaction(IOTA::Models::Transaction(BUNDLE_1_TRX_3_TRYTES));
+  b.addTransaction(IOTA::Models::Transaction(BUNDLE_1_TRX_4_TRYTES));
 
   b.finalize();
 
   for (const auto& trx : b.getTransactions()) {
-    EXPECT_EQ(trx.getBundle(),
-              "OE9RXPMWDVHVQSDAQSUQBXAIBTFTEJWOFFD99CLBACFTVGLRNIMKSEMSAF9XZLGYMFAEAQXKUNCORMUAD");
+    EXPECT_EQ(trx.getBundle(), BUNDLE_1_HASH);
   }
 }