Candidate for 6.0.0 release

.gitignore

@@ -8,7 +8,9 @@
 *.fdb_latexmk
 *.gz
 
+yarn.lock
 *.log
+yarn.lock
 docs/spec/out/
 test-out/
 flamegraphs/

README.md

@@ -97,7 +97,7 @@ This library is
 on Maven repository and can be added to the SBT configuration of Scala project.
 
 ```scala
-libraryDependencies += "org.scorexfoundation" %% "sigma-state" % "5.0.14"
+libraryDependencies += "org.scorexfoundation" %% "sigma-state" % "6.0.0"
 ```
 
 ## Repository Organization

build.sbt

@@ -82,9 +82,9 @@ ThisBuild / dynverSeparator := "-"
 
 val bouncycastleBcprov = "org.bouncycastle" % "bcprov-jdk15on" % "1.66"
 
-val scrypto            = "org.scorexfoundation" %% "scrypto" % "2.3.0-4-a0bc6176-SNAPSHOT"
+val scrypto            = "org.scorexfoundation" %% "scrypto" % "3.0.0"
 val scryptoDependency =
-  libraryDependencies += "org.scorexfoundation" %%% "scrypto" % "2.3.0-4-a0bc6176-SNAPSHOT"
+  libraryDependencies += "org.scorexfoundation" %%% "scrypto" % "3.0.0"
 
 val scorexUtil         = "org.scorexfoundation" %% "scorex-util" % "0.2.1"
 val scorexUtilDependency =

core/js/src/main/scala/sigma/js/GroupElement.scala

@@ -1,6 +1,6 @@
 package sigma.js
 
-import sigma.Extensions.CoreArrayByteOps
+import scorex.util.encode.Base16
 import sigma.crypto.{CryptoFacade, CryptoFacadeJs, Ecp, Platform}
 
 import scala.scalajs.js
@@ -13,7 +13,7 @@ class GroupElement(val point: Ecp) extends js.Object {
     * @see CryptoFacade.getASN1Encoding
     */
   def toPointHex(): String = {
-    CryptoFacade.getASN1Encoding(point, true).toHex
+    Base16.encode(CryptoFacade.getASN1Encoding(point, true))
   }
 }
 

core/js/src/main/scala/sigma/js/Isos.scala

@@ -8,6 +8,9 @@ import scala.reflect.ClassTag
 import scala.scalajs.js
 import scala.scalajs.js.JSConverters.JSRichOption
 
+/** Definitions of isomorphisms for sigma-core module.
+  * @see sigma.data.Iso
+  */
 object Isos {
 
   implicit def isoUndefOr[A, B](implicit iso: Iso[A, B]): Iso[js.UndefOr[A], Option[B]] = new Iso[js.UndefOr[A], Option[B]] {

core/shared/src/main/scala/sigma/Colls.scala

@@ -45,6 +45,19 @@ trait Coll[@specialized A] {
     */
   def apply(i: Int): A
 
+  /** The element at given index or None if there is no such element. Indices start at `0`.
+    *
+    *  @param  i       the index
+    *  @return         the element at the given index, or None if there is no such element
+    */
+  def get(i: Int): Option[A] = {
+    if (isDefinedAt(i)) {
+      Some(apply(i))
+    } else {
+      None
+    }
+  }
+
   /** Tests whether this $coll contains given index.
     *
     *  The implementations of methods `apply` and `isDefinedAt` turn a `Coll[A]` into
@@ -76,6 +89,18 @@ trait Coll[@specialized A] {
     * produces a collection ((x0, y0), ..., (xK, yK)) where K = min(N, M) */
   def zip[@specialized B](ys: Coll[B]): Coll[(A, B)]
 
+  /**
+    * @return true if first elements of this collection form given `ys` collection, false otherwise.
+    *         E.g. [1,2,3] starts with [1,2]
+    */
+  def startsWith(ys: Coll[A]): Boolean
+
+  /**
+    * @return true if last elements of this collection form given `ys` collection, false otherwise.
+    *         E.g. [1,2,3] ends with [2,3]
+    */
+  def endsWith(ys: Coll[A]): Boolean
+
   /** Tests whether a predicate holds for at least one element of this collection.
     *  @param   p     the predicate used to test elements.
     *  @return        `true` if the given predicate `p` is satisfied by at least one element of this collection, otherwise `false`

core/shared/src/main/scala/sigma/Environment.scala

@@ -14,7 +14,7 @@ sealed abstract class Environment {
 
 object Environment {
   /** Current runtime environment. */
-  implicit val current: Environment = new Environment {
+  val current: Environment = new Environment {
     override def isJVM: Boolean = runtimePlatform == RuntimePlatform.JVM
     override def isJS: Boolean = runtimePlatform == RuntimePlatform.JS
     override def runtimePlatform: RuntimePlatform = sigma.reflection.Platform.runtimePlatform

core/shared/src/main/scala/sigma/Extensions.scala

@@ -9,11 +9,6 @@ import sigma.data.RType
   * See `implicit class ...` wrappers below.
   */
 object Extensions {
-  /** Extension methods for `Array[Byte]` not available for generic `Array[T]`. */
-  implicit class CoreArrayByteOps(val arr: Array[Byte]) extends AnyVal {
-    /** Encodes array into hex string */
-    @inline def toHex: String = Base16.encode(arr)
-  }
 
   /** Extension methods for `Array[T]` where implicit descriptor `RType[T]` is also
     * required.

core/shared/src/main/scala/sigma/SigmaDsl.scala

@@ -1,13 +1,12 @@
 package sigma
 
-import java.math.BigInteger
+import sigma.ast.SType
 
+import java.math.BigInteger
 import sigma.data._
 
 /**
-  * All `modQ` operations assume that Q is a global constant (an order of the only one cryptographically strong group
-  * which is used for all cryptographic operations).
-  * So it is globally and implicitly used in all methods.
+  * Functions defined for 256-bit signed integers
   * */
 trait BigInt {
   /** Convert this BigInt value to Byte.
@@ -154,6 +153,22 @@ trait BigInt {
     */
   def or(that: BigInt): BigInt
   def |(that: BigInt): BigInt = or(that)
+
+  /**
+    * @return a big integer whose value is `this xor that`.
+    *         This method returns a negative BigInteger if and only if exactly one of this and val are negative.
+    */
+  def xor(that: BigInt): BigInt
+
+  /**
+    * @return a 256-bit signed integer whose value is (this << n). `n` should be in 0..255 range (inclusive).
+    */
+  def shiftLeft(n: Int): BigInt
+
+  /**
+    * @return a 256-bit signed integer whose value is (this >> n). `n` should be in 0..255 range (inclusive).
+    */
+  def shiftRight(n: Int): BigInt
 }
 
 /** Base class for points on elliptic curves. */
@@ -459,6 +474,23 @@ trait Header {
 
   /** Miner votes for changing system parameters. */
   def votes: Coll[Byte] //3 bytes
+
+  /** Bytes which are coming from future versions of the protocol, so
+    * their meaning is not known to current version of Sigma, but they
+    * are stored to get the same id as future version users.
+    */
+  def unparsedBytes: Coll[Byte]
+
+  /**
+    * @return header bytes without proof of work, a PoW is generated over them
+    */
+  def serializeWithoutPoW: Coll[Byte]
+
+  /**
+    * @return result of header's proof-of-work validation
+    */
+  def checkPow: Boolean
+
 }
 
 /** Runtime representation of Context ErgoTree type.
@@ -557,6 +589,17 @@ trait Context {
     */
   def getVar[T](id: Byte)(implicit cT: RType[T]): Option[T]
 
+  /**
+    * A variant of `getVar` to extract a context variable by id and type from any input
+    *
+    * @param inputIndex - input index
+    * @param id - context variable id
+    * @tparam T - expected type of the variable
+    * @return Some(value) if the variable is defined in the context AND has the given type.
+    *         None otherwise
+    */
+  def getVarFromInput[T](inputIndex: Short, id: Byte)(implicit cT: RType[T]): Option[T]
+
   def vars: Coll[AnyValue]
 
   /** Maximum version of ErgoTree currently activated on the network.
@@ -727,7 +770,13 @@ trait SigmaDslBuilder {
   /** Construct a new authenticated dictionary with given parameters and tree root digest. */
   def avlTree(operationFlags: Byte, digest: Coll[Byte], keyLength: Int, valueLengthOpt: Option[Int]): AvlTree
 
+  /** Serializes the given `value` into bytes using the default serialization format. */
+  def serialize[T](value: T)(implicit cT: RType[T]): Coll[Byte]
+
   /** Returns a byte-wise XOR of the two collections of bytes. */
   def xor(l: Coll[Byte], r: Coll[Byte]): Coll[Byte]
+
+  /** Returns a number decoded from provided big-endian bytes array. */
+  def fromBigEndianBytes[T](bytes: Coll[Byte])(implicit cT: RType[T]): T
 }
 

core/shared/src/main/scala/sigma/VersionContext.scala

@@ -1,6 +1,6 @@
 package sigma
 
-import VersionContext.JitActivationVersion
+import VersionContext.{JitActivationVersion, V6SoftForkVersion}
 
 import scala.util.DynamicVariable
 
@@ -21,6 +21,10 @@ case class VersionContext(activatedVersion: Byte, ergoTreeVersion: Byte) {
   /** @return true, if the activated script version of Ergo protocol on the network is
    * greater than v1. */
   def isJitActivated: Boolean = activatedVersion >= JitActivationVersion
+
+  /** @return true, if the activated script version of Ergo protocol on the network is
+   * including v6.0 update. */
+  def isV6SoftForkActivated: Boolean = activatedVersion >= V6SoftForkVersion
 }
 
 object VersionContext {
@@ -31,13 +35,21 @@ object VersionContext {
     * - version 3.x this value must be 0
     * - in v4.0 must be 1
     * - in v5.x must be 2
+    * - in 6.x must be 3
     * etc.
     */
-  val MaxSupportedScriptVersion: Byte = 2 // supported versions 0, 1, 2
+  val MaxSupportedScriptVersion: Byte = 3 // supported versions 0, 1, 2, 3
 
-  /** The first version of ErgoTree starting from which the JIT costing interpreter is used. */
+  /** The first version of ErgoTree starting from which the JIT costing interpreter must be used.
+    * It must also be used for all subsequent versions (3, 4, etc).
+    */
   val JitActivationVersion: Byte = 2
 
+  /**
+   * The version of ErgoTree corresponding to "evolution" (6.0) soft-fork
+   */
+  val V6SoftForkVersion: Byte = 3
+
   private val _defaultContext = VersionContext(
     activatedVersion = 1 /* v4.x */,
     ergoTreeVersion  = 1