ETCM-165: Separate bytes project.

Author: aakoshh

.buildkite/pipeline.nix

@@ -62,6 +62,19 @@ in
       '';
     };
 
+    test-bytes = commonAttrs // {
+      dependsOn = [ compile ];
+      label = "bytes tests";
+      command = ''
+        nix-shell --run '$SBT coverage bytes/test'
+      '';
+      artifactPaths = [
+        "bytes/target/test-reports/**/*"
+        "bytes/target/scala-2.12/scoverage-report/**/*"
+        "bytes/target/scala-2.12/coverage-report/**/*"
+      ];
+    };
+
     test-rlp = commonAttrs // {
       dependsOn = [ compile ];
       label = "RLP tests";

build.sbt

@@ -18,7 +18,6 @@ def commonSettings(projectName: String): Seq[sbt.Def.Setting[_]] = Seq(
   resolvers += "Sonatype OSS Snapshots" at "https://oss.sonatype.org/content/repositories/snapshots",
   testOptions in Test += Tests
     .Argument(TestFrameworks.ScalaTest, "-l", "EthashMinerSpec"), // miner tests disabled by default,
-
   scalacOptions := Seq(
     "-unchecked",
     "-deprecation",
@@ -31,38 +30,50 @@ def commonSettings(projectName: String): Seq[sbt.Def.Setting[_]] = Seq(
     "-encoding",
     "utf-8"
   ),
-
   scalacOptions in (Compile, console) ~= (_.filterNot(
     Set(
       "-Ywarn-unused-import",
       "-Xfatal-warnings"
     )
   )),
-
   scalacOptions ~= (options => if (mantisDev) options.filterNot(_ == "-Xfatal-warnings") else options),
-
   Test / parallelExecution := true,
-
   testOptions in Test += Tests.Argument("-oDG"),
-
   (scalastyleConfig in Test) := file("scalastyle-test-config.xml")
 )
 
-lazy val rlp = {
+lazy val bytes = {
   // Adding an "it" config because in `Dependencies.scala` some are declared with `% "it,test"`
   // which would fail if the project didn't have configuration to add to.
   val Integration = config("it") extend Test
 
+  val bytes = project
+    .in(file("bytes"))
+    .configs(Integration)
+    .settings(commonSettings("mantis-bytes"))
+    .settings(
+      libraryDependencies ++=
+        Dependencies.akkaUtil ++
+          Dependencies.testing
+    )
+
+  bytes
+}
+
+lazy val rlp = {
+  val Integration = config("it") extend Test
+
   val rlp = project
-  .in(file("rlp"))
-  .configs(Integration)
-  .settings(commonSettings("mantis-rlp"))
-  .settings(
-    libraryDependencies ++=
-      Dependencies.akkaUtil ++
-      Dependencies.shapeless ++
-      Dependencies.testing
-  )
+    .in(file("rlp"))
+    .configs(Integration)
+    .dependsOn(bytes)
+    .settings(commonSettings("mantis-rlp"))
+    .settings(
+      libraryDependencies ++=
+        Dependencies.akkaUtil ++
+          Dependencies.shapeless ++
+          Dependencies.testing
+    )
 
   rlp
 }
@@ -124,7 +135,7 @@ lazy val node = {
     .in(file("."))
     .configs(Integration, Benchmark, Evm, Ets, Snappy, Rpc)
     .enablePlugins(BuildInfoPlugin)
-    .dependsOn(rlp)
+    .dependsOn(bytes, rlp)
     .settings(
       buildInfoKeys := Seq[BuildInfoKey](name, version, git.gitHeadCommit),
       buildInfoPackage := "io.iohk.ethereum.utils"
@@ -134,7 +145,7 @@ lazy val node = {
       libraryDependencies ++= dep
     )
     .settings(
-      executableScriptName := name.value,
+      executableScriptName := name.value
     )
     .settings(
       inConfig(Integration)(
@@ -153,23 +164,19 @@ lazy val node = {
       PB.targets in Compile := Seq(
         scalapb.gen() -> (sourceManaged in Compile).value / "protobuf"
       ),
-
       // have the protobuf API version file as a resource
       unmanagedResourceDirectories in Compile += baseDirectory.value / "src" / "main" / "protobuf",
-
       // Packaging
       mainClass in Compile := Some("io.iohk.ethereum.App"),
       discoveredMainClasses in Compile := Seq(),
       // Requires the 'ant-javafx.jar' that comes with Oracle JDK
       // Enables creating an executable with the configuration files, has to be run on the OS corresponding to the desired version
       ThisBuild / jdkPackagerType := "image",
-
       mappings in Universal += (resourceDirectory in Compile).value / "logback.xml" -> "conf/logback.xml",
       mappings in Universal += (resourceDirectory in Compile).value / "application.conf" -> "conf/base.conf",
       mappings in Universal ++= directory((resourceDirectory in Compile).value / "chains").map { case (f, name) =>
         f -> s"conf/$name"
       },
-
       jdkPackagerJVMArgs := Seq(
         "-Dconfig.file=." + sep + "conf" + sep + "app.conf",
         "-Dlogback.configurationFile=." + sep + "conf" + sep + "logback.xml",
@@ -187,7 +194,9 @@ coverageExcludedPackages := "io\\.iohk\\.ethereum\\.extvm\\.msg.*"
 
 addCommandAlias(
   "compile-all",
-  """;rlp/compile
+  """;bytes/compile
+    |;bytes/test:compile
+    |;rlp/compile
     |;rlp/test:compile
     |;compile
     |;test:compile
@@ -204,6 +213,9 @@ addCommandAlias(
 addCommandAlias(
   "pp",
   """;compile-all
+    |;bytes/scalafmtAll
+    |;bytes/scalastyle
+    |;bytes/test:scalastyle
     |;rlp/scalafmtAll
     |;rlp/scalastyle
     |;rlp/test:scalastyle

src/main/scala/io/iohk/ethereum/utils/ByteUtils.scala renamed to bytes/src/main/scala/io/iohk/ethereum/utils/ByteUtils.scala

@@ -40,6 +40,12 @@ object ByteUtils {
   def toBigInt(bytes: ByteString): BigInt =
     bytes.foldLeft(BigInt(0)) { (n, b) => (n << 8) + (b & 0xff) }
 
+  def bigIntToUnsignedByteArray(i: BigInt): Array[Byte] = {
+    val asByteArray = i.toByteArray
+    if (asByteArray.head == 0) asByteArray.tail
+    else asByteArray
+  }
+
   /**
     * Calculates xor distance between two byte arrays. Due to performance reasons needs to be as fast as possible
     * which means usage of while loops and var's.

src/test/scala/io/iohk/ethereum/utils/ByteUtilsSpec.scala renamed to bytes/src/test/scala/io/iohk/ethereum/utils/ByteUtilsSpec.scala

@@ -1,10 +1,13 @@
 package io.iohk.ethereum.utils
 
-import io.iohk.ethereum.ObjectGenerators
 import org.scalatestplus.scalacheck.ScalaCheckPropertyChecks
 import org.scalatest.funsuite.AnyFunSuite
+import org.scalacheck.{Arbitrary, Gen}
+
+class ByteUtilsSpec extends AnyFunSuite with ScalaCheckPropertyChecks {
+  def byteArrayOfNItemsGen(n: Int): Gen[Array[Byte]] =
+    Gen.listOfN(n, Arbitrary.arbitrary[Byte]).map(_.toArray)
 
-class ByteUtilsSpec extends AnyFunSuite with ScalaCheckPropertyChecks with ObjectGenerators {
   test("Convert Bytes to Int in little endian") {
     forAll(byteArrayOfNItemsGen(32)) { bytes =>
       val toInts = ByteUtils.bytesToInts(bytes, bigEndian = false)

rlp/src/main/scala/io/iohk/ethereum/rlp/RLP.scala

@@ -135,12 +135,6 @@ private[rlp] object RLP {
     else Array[Byte](singleByte)
   }
 
-  private[rlp] def bigIntToUnsignedByteArray(i: BigInt): Array[Byte] = {
-    val asByteArray = i.toByteArray
-    if (asByteArray.head == 0) asByteArray.tail
-    else asByteArray
-  }
-
   /**
     * This function converts a short value to a big endian byte array of minimal length
     *

rlp/src/main/scala/io/iohk/ethereum/rlp/RLPImplicits.scala

@@ -2,6 +2,7 @@ package io.iohk.ethereum.rlp
 
 import akka.util.ByteString
 import io.iohk.ethereum.rlp.RLP._
+import io.iohk.ethereum.utils.ByteUtils
 import RLPCodec.Ops
 
 object RLPImplicits {
@@ -50,7 +51,7 @@ object RLPImplicits {
   implicit val bigIntEncDec = new RLPEncoder[BigInt] with RLPDecoder[BigInt] {
 
     override def encode(obj: BigInt): RLPValue = RLPValue(
-      if (obj.equals(BigInt(0))) byteToByteArray(0: Byte) else bigIntToUnsignedByteArray(obj)
+      if (obj.equals(BigInt(0))) byteToByteArray(0: Byte) else ByteUtils.bigIntToUnsignedByteArray(obj)
     )
 
     override def decode(rlp: RLPEncodeable): BigInt = rlp match {

src/main/scala/io/iohk/ethereum/utils/BigIntExtensionMethods.scala

@@ -4,11 +4,8 @@ import io.iohk.ethereum.domain.UInt256
 
 object BigIntExtensionMethods {
   implicit class BigIntAsUnsigned(val srcBigInteger: BigInt) extends AnyVal {
-    def toUnsignedByteArray: Array[Byte] = {
-      val asByteArray = srcBigInteger.toByteArray
-      if (asByteArray.head == 0) asByteArray.tail
-      else asByteArray
-    }
+    def toUnsignedByteArray: Array[Byte] =
+      ByteUtils.bigIntToUnsignedByteArray(srcBigInteger)
 
     def u256: UInt256 = UInt256(srcBigInteger)
   }