sigma.data.SigmaConstants.scala Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of sigma-state_2.12 Show documentation
Interpreter of a Sigma-State language
The newest version!
package sigma.data

import sigma.util.CollectionUtil.TraversableOps // used in Scala 2.11

/** Descriptor of a constant which represents some size value.
  * @tparam T type of the constant value
  * @param value value of the constant
  * @param id    unique id of the constant
  * @param description description of the constant purpose
  */
case class SizeConstant[T: Numeric](value: T, id: Short, description: String)

/** Constants facade that provide access to the values used in sigma's logic and checks.
  * All the constants are collected in a sequence.
  * Each constant has id, value and description.
  * The constant ids are stable and never change.
  * Some constant values may be defined in terms of other more fundamental values.
  * In the future versions of sigma, the values may change,
  * but due to versioned execution, all versions of the values should be
  * available simultaneously.
  */
object SigmaConstants {

  object MaxBoxSize extends SizeConstant[Int](4 * 1024, 1,
    "Box size should not be greater than provided value") {
  }

  object MaxTreeDepth extends SizeConstant[Int](110, 2,
    "Max tree depth should not be greater then provided value") {
  }

  object MaxTokens extends SizeConstant[Int](255, 3,
    "Tokens count should not be greater than provided value") {
  }

  object MaxRegisters extends SizeConstant[Int](10, 4,
    "Registers count should not be greater than provided value") {
  }

  object MaxPropositionBytes extends SizeConstant[Int](4096 /*4K*/, 5,
    "Max length of Box.propositionBytes collection") {
  }

  object MaxBoxSizeWithoutRefs extends SizeConstant[Int](
    MaxBoxSize.value - (32/*CryptoConstants.hashLength*/ + 2/*size of Short*/), 6,
    "Box size should not be greater than provided value") {
  }

  object MaxBigIntSizeInBytes extends SizeConstant[Long](32L, 7,
    "BigInt size in bytes should not be greater than provided value") {
  }

  object MaxSigmaPropSizeInBytes extends SizeConstant[Long](1024L, 8,
    "SigmaProp size in bytes should not be greater than provided value") {
  }

  object MaxTupleLength extends SizeConstant[Int](255, 9,
    "Tuple length should not be greater than provided value") {
  }

  object MaxHeaders extends SizeConstant[Int](10, 10,
    "Headers count should not be greater than provided value") {
  }

  object MaxChildrenCountForAtLeastOp extends SizeConstant[Int](255, 11,
    "Max children count should not be greater than provided value") {
  }

  object MaxLoopLevelInCostFunction extends SizeConstant[Int](1, 13,
    "Maximum allowed loop level in a cost function") {
  }

  object VotesArraySize extends SizeConstant[Int](3, 14,
    "Size of of Header.votes array") {
  }

  object AutolykosPowSolutionNonceArraySize extends SizeConstant[Int](8, 15,
    "size of nonce array from Autolykos POW solution in Header.powNonce array") {
  }

  /** List of registered size constants with unique ids. */
  val ConstTable: Seq[SizeConstant[_]] = {
    val rows = Seq(
      MaxBoxSize,
      MaxTreeDepth,
      MaxTokens,
      MaxRegisters,
      MaxPropositionBytes,
      MaxBoxSizeWithoutRefs,
      MaxBigIntSizeInBytes,
      MaxSigmaPropSizeInBytes,
      MaxTupleLength,
      MaxHeaders,
      MaxChildrenCountForAtLeastOp,
      MaxLoopLevelInCostFunction,
      VotesArraySize,
      AutolykosPowSolutionNonceArraySize
    )
    require(rows.length == rows.distinctBy(_.id).length, s"Duplicate constant id in $rows")
    rows
  }
}