A sidechain prototype

.github/workflows/ci.yml

@@ -57,6 +57,49 @@ jobs:
           SONATYPE_PASSWORD: ${{ secrets.SONATYPE_PASSWORD }}
           SONATYPE_USERNAME: ${{ secrets.SONATYPE_USERNAME }}
 
+  test_core:
+    name: Run ergo-core tests and publish a ergo-core snapshot
+    env:
+      HAS_SECRETS: ${{ secrets.SONATYPE_PASSWORD != '' }}
+    strategy:
+      matrix:
+        os: [ubuntu-latest]
+        scala: [2.13.12, 2.12.18, 2.11.12]
+        java: [[email protected]]
+    runs-on: ${{ matrix.os }}
+    steps:
+      - name: Checkout current branch (full)
+        uses: actions/checkout@v2
+        with:
+          fetch-depth: 0
+
+      - name: Setup Java and Scala
+        uses: olafurpg/setup-scala@v10
+        with:
+          java-version: ${{ matrix.java }}
+
+      - name: Cache sbt
+        uses: actions/cache@v2
+        with:
+          path: |
+            ~/.sbt
+            ~/.ivy2/cache
+            ~/.coursier/cache/v1
+            ~/.cache/coursier/v1
+            ~/AppData/Local/Coursier/Cache/v1
+            ~/Library/Caches/Coursier/v1
+          key: ${{ runner.os }}-sbt-cache-v2-${{ hashFiles('**/*.sbt') }}-${{ hashFiles('project/build.properties') }}
+
+      - name: Runs ergo-core tests
+        run: sbt ++${{ matrix.scala }} ergoCore/test
+
+      - name: Publish a wallet snapshot ${{ github.ref }}
+        if: env.HAS_SECRETS == 'true'
+        run: sbt ++${{ matrix.scala }} ergoCore/publish
+        env:
+          SONATYPE_PASSWORD: ${{ secrets.SONATYPE_PASSWORD }}
+          SONATYPE_USERNAME: ${{ secrets.SONATYPE_USERNAME }}
+
   test_node:
     name: Run node tests
     strategy:

avldb/src/test/scala/scorex/crypto/authds/avltree/batch/benchmark/OOMTest.scala

@@ -11,9 +11,16 @@ import scorex.crypto.hash.{Blake2b256, Digest32}
 import scorex.db.{ByteArrayWrapper, LDBVersionedStore}
 
 import scala.collection.immutable.SortedMap
+import scala.math.Ordering.Implicits._
 
 object OOMTest extends App {
 
+  implicit val ordering: Ordering[Array[Byte]] =
+    new Ordering[Array[Byte]] {
+      override def compare(o1: Array[Byte], o2: Array[Byte]): Int =
+        implicitly[Ordering[Seq[Int]]].compare(o1.toSeq.map(_ & 0xFF), o2.toSeq.map(_ & 0xFF))
+    }
+
   type Box = (ADKey, ADValue)
 
   type HF = Blake2b256.type

build.sbt

@@ -255,6 +255,7 @@ lazy val ergoCore = (project in file("ergo-core"))
     ),
     scalacOptions in(Compile, compile) ++= (if (scalaBinaryVersion.value == "2.11") Seq() else Seq("-release", "8")),
     scalacOptions in(Compile, compile) --= scalacOpts,
+    parallelExecution in Test := false,
   )
 
 lazy val ergoWallet = (project in file("ergo-wallet"))

ergo-core/README.md

@@ -72,7 +72,9 @@ val handshakeMessageSerialized = HandshakeSerializer.toBytes(handshakeMessage)
 Serialize the message and send it.
 If the message arrived successfully, start communicating with the peer node.
 
-All communication is wrapped with Message headers, format described [here](https://docs.ergoplatform.com/dev/p2p/network/#message-format).
+All communication is wrapped with message headers.
+Format described [here](https://docs.ergoplatform.com/dev/p2p/network/#message-format).
+[MessageBase](src/main/scala/org/ergoplatform/network/message/MessageBase.scala) interface to implement.
 
 ## Syncing with the node
 

ergo-core/build.sbt

@@ -12,6 +12,9 @@ val deps212 = Seq(
   "io.circe" %% "circe-generic" % "0.13.0",
   "io.circe" %% "circe-parser" % "0.13.0")
 
+publishMavenStyle := true
+publishArtifact in Test := false
+
 libraryDependencies ++= Seq() ++
   (if (scalaVersion.value == scala211) deps211 else deps212)
 

ergo-core/src/main/scala/org/ergoplatform/mining/AutolykosPowScheme.scala

@@ -425,3 +425,5 @@ object AutolykosPowScheme {
   }
 
 }
+
+object MainnetPoWVerifier extends AutolykosPowScheme(k = 32, n = 26)

ergo-core/src/main/scala/org/ergoplatform/mining/AutolykosSolution.scala

@@ -6,6 +6,7 @@ import io.circe.syntax._
 import io.circe.{Decoder, Encoder, HCursor}
 import org.bouncycastle.util.BigIntegers
 import org.ergoplatform.http.api.ApiCodecs
+import org.ergoplatform.mining.AutolykosSolution.pkForV2
 import org.ergoplatform.modifiers.history.header.Header.Version
 import org.ergoplatform.settings.Algos
 import org.ergoplatform.serialization.ErgoSerializer
@@ -59,6 +60,30 @@ object AutolykosSolution extends ApiCodecs {
 
 }
 
+case class WeakAutolykosSolution(pk: EcPointType, n: Array[Byte]) {
+  val encodedPk: Array[Byte] = groupElemToBytes(pk)
+}
+
+object WeakAutolykosSolution extends ApiCodecs {
+  implicit val jsonEncoder: Encoder[WeakAutolykosSolution] = { s: WeakAutolykosSolution =>
+    Map(
+      "pk" -> s.pk.asJson,
+      "n" -> Algos.encode(s.n).asJson
+    ).asJson
+  }
+
+  implicit val jsonDecoder: Decoder[WeakAutolykosSolution] = { c: HCursor =>
+    for {
+      pkOpt <- c.downField("pk").as[Option[EcPointType]]
+      n <- c.downField("n").as[Array[Byte]]
+    } yield {
+      WeakAutolykosSolution(pkOpt.getOrElse(pkForV2), n)
+    }
+  }
+
+}
+
+
 
 /**
   * Binary serializer for Autolykos v1 solution,

ergo-core/src/main/scala/org/ergoplatform/modifiers/history/extension/Extension.scala

@@ -71,6 +71,16 @@ object Extension extends ApiCodecs {
     */
   val ValidationRulesPrefix: Byte = 0x02
 
+  /**
+    * Prefix for keys related to sub-blocks related data.
+    */
+  val SubBlocksDataPrefix: Byte = 0x03
+
+  /**
+    * Prefix for keys related to sidechains data.
+    */
+  val SidechainsDataPrefix: Byte = 0x04
+
   /**
     * Id a type of network object encoding extension
     */

ergo-core/src/main/scala/org/ergoplatform/network/message/MessageBase.scala

@@ -0,0 +1,48 @@
+package org.ergoplatform.network.message
+
+import org.ergoplatform.network.message.MessageConstants._
+
+import scala.util.{Success, Try}
+
+/**
+  * Trait for a ergo network message
+  *
+  * @param spec   - message specification
+  * @param input  - message being wrapped, whether in byte-array form (if from outside),
+  *               or structured data (if formed locally)
+  * @tparam Content - message data type
+  */
+trait MessageBase[Content] {
+  val spec: MessageSpec[Content]
+  val input: Either[Array[Byte], Content]
+
+  /**
+    * Message data bytes
+    */
+  lazy val dataBytes: Array[Byte] = input match {
+    case Left(db) => db
+    case Right(d) => spec.toBytes(d)
+  }
+
+  /**
+    * Structured message content
+    */
+  lazy val data: Try[Content] = input match {
+    case Left(db) => spec.parseBytesTry(db)
+    case Right(d) => Success(d)
+  }
+
+  lazy val dataLength: Int = dataBytes.length
+
+  /**
+    * @return serialized message length in bytes
+    */
+  def messageLength: Int = {
+    if (dataLength > 0) {
+      HeaderLength + ChecksumLength + dataLength
+    } else {
+      HeaderLength
+    }
+  }
+
+}

ergo-core/src/main/scala/org/ergoplatform/nodeView/mempool/TransactionMembershipProof.scala

@@ -4,7 +4,7 @@ import io.circe.{Encoder, Json}
 import org.ergoplatform.sdk.JsonCodecs
 import org.ergoplatform.settings.Algos
 import scorex.crypto.authds.merkle.MerkleProof
-import scorex.crypto.hash.Digest32
+import scorex.crypto.hash.{Digest, Digest32}
 import scorex.util.ModifierId
 import io.circe.syntax._
 
@@ -15,7 +15,11 @@ import io.circe.syntax._
   * @param txId - transaction identifier
   * @param proof - Merkle proof of transaction membership
   */
-case class TransactionMembershipProof(txId: ModifierId, proof: MerkleProof[Digest32])
+case class TransactionMembershipProof(txId: ModifierId, proof: MerkleProof[Digest32]) {
+  def valid(expectedRootHash: Digest): Boolean = {
+    proof.valid(expectedRootHash)
+  }
+}
 
 object TransactionMembershipProof extends JsonCodecs {
 

ergo-core/src/main/scala/org/ergoplatform/settings/ChainSettingsReader.scala

@@ -0,0 +1,26 @@
+package org.ergoplatform.settings
+
+import com.typesafe.config.ConfigFactory
+import net.ceedubs.ficus.Ficus._
+import net.ceedubs.ficus.readers.ArbitraryTypeReader._
+import java.io.File
+
+object ChainSettingsReader extends PowSchemeReaders with ModifierIdReader with SettingsReaders{
+  def read(path: String): Option[ChainSettings] = {
+    val file = new File(path)
+    if (file.exists) {
+      val cfg = ConfigFactory.parseFile(file)
+      val fallback = ConfigFactory.parseFile(new File("src/main/resources/application.conf"))
+      val network = ConfigFactory.parseFile(new File("src/main/resources/testnet.conf"))
+      val fullConfig = ConfigFactory
+        .defaultOverrides()
+        .withFallback(cfg) //order
+        .withFallback(network) //matters
+        .withFallback(fallback) //here
+        .resolve()
+
+      val chainSettings = fullConfig.as[ChainSettings]("ergo.chain")
+      Some(chainSettings)
+    } else None
+  }
+}

ergo-core/src/main/scala/org/ergoplatform/settings/ModifierIdReader.scala

@@ -0,0 +1,15 @@
+package org.ergoplatform.settings
+
+import com.typesafe.config.Config
+import net.ceedubs.ficus.readers.ValueReader
+import scorex.util.ModifierId
+
+trait ModifierIdReader {
+
+  implicit val modifierIdReader: ValueReader[ModifierId] = new ValueReader[ModifierId] {
+    override def read(cfg: Config, path: String): ModifierId = {
+      ModifierId @@ cfg.getString(path)
+    }
+  }
+
+}

ergo-core/src/main/scala/org/ergoplatform/settings/PowSchemeReaders.scala

@@ -0,0 +1,26 @@
+package org.ergoplatform.settings
+
+import com.typesafe.config.{Config, ConfigException}
+import net.ceedubs.ficus.Ficus._
+import net.ceedubs.ficus.readers.ValueReader
+import org.ergoplatform.mining._
+
+trait PowSchemeReaders {
+
+  implicit val powSchemeReader: ValueReader[AutolykosPowScheme] = new ValueReader[AutolykosPowScheme] {
+    override def read(cfg: Config, path: String): AutolykosPowScheme = {
+      val schemeNameKey = s"$path.powType"
+      val schemeName = cfg.getString(schemeNameKey)
+      val n = cfg.as[Int](s"$path.n")
+      val k = cfg.as[Int](s"$path.k")
+      if (schemeName == "autolykos") {
+        new AutolykosPowScheme(k, n)
+      } else if (schemeName == "fake") {
+        new DefaultFakePowScheme(k, n)
+      } else {
+        throw new ConfigException.BadValue(schemeNameKey, schemeName)
+      }
+    }
+  }
+}
+