Block (#68)

turuslan · web-flow · commit 0629e120f2dd · 2020-01-16T15:11:09.000+03:00
Signed-off-by: turuslan &lt;turuslan.devbox@gmail.com&gt;
diff --git a/core/codec/cbor/cbor.hpp b/core/codec/cbor/cbor.hpp
@@ -38,7 +38,7 @@ namespace fc::codec::cbor {
   template <typename T>
   outcome::result<T> decode(gsl::span<const uint8_t> input) {
     try {
-      T data;
+      T data{};
       CborDecodeStream decoder(input);
       decoder >> data;
       return data;
diff --git a/core/codec/cbor/cbor_common.hpp b/core/codec/cbor/cbor_common.hpp
@@ -8,6 +8,7 @@
 
 #include <cstdint>
 
+#include <boost/optional.hpp>
 #include <libp2p/multi/content_identifier_codec.hpp>
 
 #include "codec/cbor/cbor_errors.hpp"
diff --git a/core/codec/cbor/cbor_decode_stream.hpp b/core/codec/cbor/cbor_decode_stream.hpp
@@ -59,6 +59,35 @@ namespace fc::codec::cbor {
       return *this;
     }
 
+    /// Decodes nullable optional value
+    template <typename T>
+    CborDecodeStream &operator>>(boost::optional<T> &optional) {
+      if (isNull()) {
+        optional = boost::none;
+        next();
+      } else {
+        T value{};
+        *this >> value;
+        optional = value;
+      }
+      return *this;
+    }
+
+    /// Decodes list elements into vector
+    template <typename T>
+    CborDecodeStream &operator>>(std::vector<T> &values) {
+      auto n = listLength();
+      auto l = list();
+      values.clear();
+      values.reserve(n);
+      for (auto i = 0u; i < n; ++i) {
+        T value{};
+        l >> value;
+        values.push_back(value);
+      }
+      return *this;
+    }
+
     /** Decodes bytes */
     CborDecodeStream &operator>>(std::vector<uint8_t> &bytes);
     /** Decodes string */
diff --git a/core/codec/cbor/cbor_encode_stream.cpp b/core/codec/cbor/cbor_encode_stream.cpp
@@ -7,7 +7,12 @@
 
 namespace fc::codec::cbor {
   CborEncodeStream &CborEncodeStream::operator<<(
-      const gsl::span<const uint8_t> &bytes) {
+      const std::vector<uint8_t> &bytes) {
+    return *this << gsl::make_span(bytes);
+  }
+
+  CborEncodeStream &CborEncodeStream::operator<<(
+      gsl::span<const uint8_t> bytes) {
     addCount(1);
 
     std::vector<uint8_t> encoded(9 + bytes.size());
diff --git a/core/codec/cbor/cbor_encode_stream.hpp b/core/codec/cbor/cbor_encode_stream.hpp
@@ -40,8 +40,31 @@ namespace fc::codec::cbor {
       return *this;
     }
 
+    /// Encodes nullable optional value
+    template <typename T>
+    CborEncodeStream &operator<<(const boost::optional<T> &optional) {
+      if (optional) {
+        *this << *optional;
+      } else {
+        *this << nullptr;
+      }
+      return *this;
+    }
+
+    /// Encodes elements into list
+    template <typename T>
+    CborEncodeStream &operator<<(const std::vector<T> &values) {
+      auto l = list();
+      for (auto &value : values) {
+        l << value;
+      }
+      return *this << l;
+    }
+
+    /** Encodes bytes */
+    CborEncodeStream &operator<<(const std::vector<uint8_t> &bytes);
     /** Encodes bytes */
-    CborEncodeStream &operator<<(const gsl::span<const uint8_t> &bytes);
+    CborEncodeStream &operator<<(gsl::span<const uint8_t> bytes);
     /** Encodes string */
     CborEncodeStream &operator<<(const std::string &str);
     /** Encodes CID */
diff --git a/core/primitives/CMakeLists.txt b/core/primitives/CMakeLists.txt
@@ -4,5 +4,6 @@
 #
 
 add_subdirectory(address)
+add_subdirectory(block)
 add_subdirectory(cid)
 add_subdirectory(ticket)
diff --git a/core/primitives/block/CMakeLists.txt b/core/primitives/block/CMakeLists.txt
@@ -0,0 +1,11 @@
+#
+# Copyright Soramitsu Co., Ltd. All Rights Reserved.
+# SPDX-License-Identifier: Apache-2.0
+#
+
+add_library(block INTERFACE)
+target_link_libraries(block INTERFACE
+    address
+    cbor
+    tickets
+    )
diff --git a/core/primitives/block/block.hpp b/core/primitives/block/block.hpp
@@ -0,0 +1,59 @@
+#include <boost/optional.hpp>
+
+#include "primitives/address/address.hpp"
+#include "primitives/address/address_codec.hpp"
+#include "primitives/big_int.hpp"
+#include "primitives/cid/cid.hpp"
+#include "primitives/ticket/epost_ticket.hpp"
+#include "primitives/ticket/epost_ticket_codec.hpp"
+#include "primitives/ticket/ticket.hpp"
+#include "primitives/ticket/ticket_codec.hpp"
+
+namespace fc::primitives::block {
+  using primitives::BigInt;
+  using primitives::address::Address;
+  using primitives::ticket::EPostProof;
+  using primitives::ticket::Ticket;
+
+  // TODO(turuslan): FIL-72 signature
+  using Signature = std::vector<uint8_t>;
+
+  struct BlockHeader {
+    Address miner;
+    boost::optional<Ticket> ticket;
+    EPostProof epost_proof;
+    std::vector<CID> parents;
+    BigInt parent_weight;
+    uint64_t height;
+    CID parent_state_root;
+    CID parent_message_receipts;
+    CID messages;
+    Signature bls_aggregate;
+    uint64_t timestamp;
+    boost::optional<Signature> block_sig;
+  };
+
+  template <class Stream,
+            typename = std::enable_if_t<
+                std::remove_reference_t<Stream>::is_cbor_encoder_stream>>
+  Stream &operator<<(Stream &&s, const BlockHeader &block) {
+    return s << (s.list() << block.miner << block.ticket << block.epost_proof
+                          << block.parents << block.parent_weight
+                          << block.height << block.parent_state_root
+                          << block.parent_message_receipts << block.messages
+                          << block.bls_aggregate << block.timestamp
+                          << block.block_sig);
+  }
+
+  template <class Stream,
+            typename = std::enable_if_t<
+                std::remove_reference_t<Stream>::is_cbor_decoder_stream>>
+  Stream &operator>>(Stream &&s, BlockHeader &block) {
+    s.list() >> block.miner >> block.ticket >> block.epost_proof
+        >> block.parents >> block.parent_weight >> block.height
+        >> block.parent_state_root >> block.parent_message_receipts
+        >> block.messages >> block.bls_aggregate >> block.timestamp
+        >> block.block_sig;
+    return s;
+  }
+}  // namespace fc::primitives::block
diff --git a/core/primitives/ticket/epost_ticket_codec.hpp b/core/primitives/ticket/epost_ticket_codec.hpp
@@ -45,15 +45,12 @@ namespace fc::primitives::ticket {
             typename = std::enable_if_t<
                 std::remove_reference<Stream>::type::is_cbor_decoder_stream>>
   Stream &operator>>(Stream &&s, EPostTicket &ticket) {
-    auto &&l = s.list();
     std::vector<uint8_t> data{};
-
-    l >> data;
+    s.list() >> data >> ticket.sector_id >> ticket.challenge_index;
     if (data.size() != ticket.partial.size()) {
       outcome::raise(EPoSTTicketCodecError::INVALID_PARTIAL_LENGTH);
     }
     std::copy(data.begin(), data.end(), ticket.partial.begin());
-    l >> ticket.sector_id >> ticket.challenge_index;
     return s;
   }
 
@@ -68,14 +65,8 @@ namespace fc::primitives::ticket {
             typename = std::enable_if_t<
                 std::remove_reference<Stream>::type::is_cbor_encoder_stream>>
   Stream &operator<<(Stream &&s, const EPostProof &epp) noexcept {
-    auto && list = s.list();
-    list << epp.proof << epp.post_rand;
-    auto &&l = list.list();
-    for (auto &item : epp.candidates) {
-      l << item;
-    }
-
-    return s << (list << l);
+    return s << (s.list() << epp.proof << epp.post_rand
+                          << epp.candidates);
   }
 
   /**
@@ -89,30 +80,13 @@ namespace fc::primitives::ticket {
             typename = std::enable_if_t<
                 std::remove_reference<Stream>::type::is_cbor_decoder_stream>>
   Stream &operator>>(Stream &&s, EPostProof &epp) {
-    std::vector<uint8_t> proof{};
-    auto &&list = s.list();
-    list >> proof;
+    std::vector<uint8_t> proof, rand;
+    s.list() >> proof >> rand >> epp.candidates;
     epp.proof = common::Buffer(std::move(proof));
-    std::vector<uint8_t> rand{};
-    list >> rand;
     if (rand.size() != epp.post_rand.size()) {
       outcome::raise(EPoSTTicketCodecError::INVALID_POST_RAND_LENGTH);
     }
     std::copy(rand.begin(), rand.end(), epp.post_rand.begin());
-
-    auto n = list.listLength();
-    std::vector<EPostTicket> candidates{};
-    candidates.reserve(n);
-
-    auto &&l = list.list();
-    for (size_t i = 0; i < n; ++i) {
-      EPostTicket ticket{};
-      l >> ticket;
-      candidates.push_back(ticket);
-    }
-
-    epp.candidates = std::move(candidates);
-
     return s;
   }
 }  // namespace fc::primitives::ticket
diff --git a/core/primitives/ticket/ticket_codec.hpp b/core/primitives/ticket/ticket_codec.hpp
@@ -45,9 +45,8 @@ namespace fc::primitives::ticket {
             typename = std::enable_if_t<
                 std::remove_reference<Stream>::type::is_cbor_decoder_stream>>
   Stream &operator>>(Stream &&s, Ticket &ticket) {
-    auto && l = s.list();
     std::vector<uint8_t> data{};
-    l >> data;
+    s.list() >> data;
     if (data.size() != ticket.bytes.size()) {
       outcome::raise(TicketCodecError::INVALID_TICKET_LENGTH);
     }
diff --git a/test/core/codec/cbor/cbor_test.cpp b/test/core/codec/cbor/cbor_test.cpp
@@ -73,6 +73,22 @@ TEST(Cbor, Null) {
   EXPECT_FALSE(CborDecodeStream("01"_unhex).isNull());
 }
 
+/** Optional CBOR encoding and decoding */
+TEST(Cbor, Optional) {
+  boost::optional<int> empty;
+  EXPECT_OUTCOME_EQ(encode(empty), "F6"_unhex);
+  EXPECT_OUTCOME_EQ(decode<boost::optional<int>>("F6"_unhex), empty);
+  EXPECT_OUTCOME_EQ(encode(boost::make_optional(3)), "03"_unhex);
+  EXPECT_OUTCOME_EQ(decode<boost::optional<int>>("03"_unhex), 3);
+}
+
+/// Vector CBOR encoding and decoding
+TEST(Cbor, Vector) {
+  std::vector<int> a{2, 5, 9};
+  EXPECT_OUTCOME_EQ(encode(a), "83020509"_unhex);
+  EXPECT_OUTCOME_EQ(decode<std::vector<int>>("83020509"_unhex), a);
+}
+
 /**
  * @given Integers and bool
  * @when Encode
diff --git a/test/core/primitives/CMakeLists.txt b/test/core/primitives/CMakeLists.txt
@@ -4,4 +4,5 @@
 #
 
 add_subdirectory(address)
+add_subdirectory(block)
 add_subdirectory(ticket)
diff --git a/test/core/primitives/block/CMakeLists.txt b/test/core/primitives/block/CMakeLists.txt
@@ -0,0 +1,12 @@
+#
+# Copyright Soramitsu Co., Ltd. All Rights Reserved.
+# SPDX-License-Identifier: Apache-2.0
+#
+
+addtest(block_test
+    block_test.cpp
+    )
+target_link_libraries(block_test
+    block
+    hexutil
+    )
diff --git a/test/core/primitives/block/block_test.cpp b/test/core/primitives/block/block_test.cpp
@@ -0,0 +1,49 @@
+/**
+ * Copyright Soramitsu Co., Ltd. All Rights Reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+#include "primitives/block/block.hpp"
+
+#include <gtest/gtest.h>
+#include "testutil/cbor.hpp"
+
+/**
+ * @given block header and its serialized representation from go
+ * @when encode @and decode the block
+ * @then decoded version matches the original @and encoded matches the go ones
+ */
+TEST(BlockTest, BlockHeaderCbor) {
+  auto bls1 =
+      "010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101"_blob96;
+  auto bls2 =
+      "020101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101"_blob96;
+  fc::primitives::block::BlockHeader block{
+      fc::primitives::address::Address::makeFromId(1),
+      boost::none,
+      {
+          fc::common::Buffer("F00D"_unhex),
+          bls1,
+          {},
+      },
+      {"010001020002"_cid},
+      fc::primitives::BigInt(3),
+      4,
+      "010001020005"_cid,
+      "010001020006"_cid,
+      "010001020007"_cid,
+      // TODO(turuslan): FIL-72 signature
+      "01CAFE"_unhex,
+      8,
+      boost::none,
+  };
+  expectEncodeAndReencode(
+      block,
+      "8c420001f68342f00d58600101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101018081d82a470001000102000242000304d82a4700010001020005d82a4700010001020006d82a47000100010200074301cafe08f6"_unhex);
+  block.ticket = fc::primitives::ticket::Ticket{bls2};
+  // TODO(turuslan): FIL-72 signature
+  block.block_sig = "01DEAD"_unhex;
+  expectEncodeAndReencode(
+      block,
+      "8c4200018158600201010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101018342f00d58600101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101018081d82a470001000102000242000304d82a4700010001020005d82a4700010001020006d82a47000100010200074301cafe084301dead"_unhex);
+}

Original file line number	Diff line number	Diff line change
`@@ -4,5 +4,6 @@`
`4`	`4`	`#`
`5`	`5`
`6`	`6`	`add_subdirectory(address)`
	`7`	`+add_subdirectory(block)`
`7`	`8`	`add_subdirectory(cid)`
`8`	`9`	`add_subdirectory(ticket)`