Merge branch 'i908' of github.com:ScorexFoundation/sigmastate-interpr…

…eter into v6.0.0-RC2
ergoplatform · Dec 19, 2024 · 210273f · 210273f
2 parents 3b7a43f + ea31523
commit 210273f
Show file tree

Hide file tree

Showing 7 changed files with 257 additions and 154 deletions.
diff --git a/data/shared/src/main/scala/sigma/ast/methods.scala b/data/shared/src/main/scala/sigma/ast/methods.scala
@@ -1769,19 +1769,19 @@ case object SAvlTreeMethods extends MonoTypeMethods {
     .withIRInfo(MethodCallIrBuilder)
     .withInfo(MethodCall,
       """
-        |  /** Perform insertions of key-value entries into this tree using proof `proof`.
+        |  /** Perform insertions or updates of key-value entries into this tree using proof `proof`.
         |    * Throws exception if proof is incorrect
-        |    *
-        |    * @note CAUTION! Pairs must be ordered the same way they were in insert ops before proof was generated.
         |    * Return Some(newTree) if successful
         |    * Return None if operations were not performed.
-        |    * @param operations   collection of key-value pairs to insert in this authenticated dictionary.
+        |    *
+        |    * @note CAUTION! Pairs must be ordered the same way they were in insert ops before proof was generated.
+        |    * @param operations   collection of key-value pairs to insert or update in this authenticated dictionary.
         |    * @param proof
         |    */
         |
         """.stripMargin)
 
-  /** Implements evaluation of AvlTree.insert method call ErgoTree node.
+  /** Implements evaluation of AvlTree.insertOrUpdate method call ErgoTree node.
     * Called via reflection based on naming convention.
     * @see SMethod.evalMethod
     */

diff --git a/data/shared/src/main/scala/sigma/eval/AvlTreeVerifier.scala b/data/shared/src/main/scala/sigma/eval/AvlTreeVerifier.scala
@@ -57,7 +57,7 @@ trait AvlTreeVerifier {
     * is None.
     *
     * @param key   key to look up
-    * @param value value to check it was updated
+    * @param value value to check it was inserted or updated
     * @return Success(Some(value)), Success(None), or Failure
     */
   def performInsertOrUpdate(key: Array[Byte], value: Array[Byte]): Try[Option[Array[Byte]]]

diff --git a/data/shared/src/main/scala/sigma/eval/ErgoTreeEvaluator.scala b/data/shared/src/main/scala/sigma/eval/ErgoTreeEvaluator.scala
@@ -134,7 +134,7 @@ abstract class ErgoTreeEvaluator {
       mc: MethodCall, tree: AvlTree,
       operations: KeyValueColl, proof: Coll[Byte]): Option[AvlTree]
 
-  /** Implements evaluation of AvlTree.insert method call ErgoTree node. */
+  /** Implements evaluation of AvlTree.insertOrUpdate method call ErgoTree node. */
   def insertOrUpdate_eval(
                    mc: MethodCall,
                    tree: AvlTree,

diff --git a/docs/LangSpec.md b/docs/LangSpec.md
@@ -749,10 +749,24 @@ class AvlTree {
     * Return None if operations were not performed.
     * @param operations collection of key-value pairs to update in this
     *                   authenticated dictionary.
-    * @param proof      data to reconstruct part of the tree
+    * @param proof      subtree which is enough to check operations
     */
   def update(operations: Coll[(Coll[Byte], Coll[Byte])], proof: Coll[Byte]): Option[AvlTree]
 
+
+ /** Perform insertions or updates of key-value entries into this tree using proof `proof`.
+   * Throws exception if proof is incorrect
+   *
+   * @note CAUTION! Pairs must be ordered the same way they were in ops
+   * before proof was generated.
+   * Return Some(newTree) if successful
+   * Return None if operations were not performed.
+   * @param operations collection of key-value pairs to insert or update in this
+   *                   authenticated dictionary.
+   * @param proof subtree which is enough to check operations
+   */
+ def insertOrUpdate(operations: Coll[(Coll[Byte], Coll[Byte])], proof: Coll[Byte]): Option[AvlTree]
+
   /** Perform removal of entries into this tree using proof `proof`.
     * Throws exception if proof is incorrect
     * Return Some(newTree) if successful

diff --git a/interpreter/shared/src/main/scala/sigmastate/eval/Extensions.scala b/interpreter/shared/src/main/scala/sigmastate/eval/Extensions.scala
@@ -3,7 +3,7 @@ package sigmastate.eval
 import debox.cfor
 import org.ergoplatform.ErgoBox
 import org.ergoplatform.ErgoBox.TokenId
-import scorex.crypto.authds.avltree.batch.{Insert, Lookup, Remove, Update}
+import scorex.crypto.authds.avltree.batch.{Insert, InsertOrUpdate, Lookup, Remove, Update}
 import scorex.crypto.authds.{ADKey, ADValue}
 import scorex.util.encode.Base16
 import sigma.ast.SType.AnyOps
@@ -91,7 +91,7 @@ object Extensions {
         val bv = CAvlTreeVerifier(tree, proof)
         entries.forall { case (key, value) =>
           val insertRes = bv.performOneOperation(Insert(ADKey @@ key.toArray, ADValue @@ value.toArray))
-          if (insertRes.isFailure) {
+          if (insertRes.isFailure && !VersionContext.current.isV6SoftForkActivated) {
             syntax.error(s"Incorrect insert for $tree (key: $key, value: $value, digest: ${tree.digest}): ${insertRes.failed.get}}")
           }
           insertRes.isSuccess
@@ -120,6 +120,24 @@ object Extensions {
       }
     }
 
+    def insertOrUpdate(
+                entries: Coll[(Coll[Byte], Coll[Byte])],
+                proof: Coll[Byte]): Option[AvlTree] = {
+      if (!tree.isInsertAllowed || !tree.isUpdateAllowed) {
+        None
+      } else {
+        val bv = CAvlTreeVerifier(tree, proof)
+        entries.forall { case (key, value) =>
+          val insertRes = bv.performOneOperation(InsertOrUpdate(ADKey @@ key.toArray, ADValue @@ value.toArray))
+          insertRes.isSuccess
+        }
+        bv.digest match {
+          case Some(d) => Some(tree.updateDigest(Colls.fromArray(d)))
+          case _ => None
+        }
+      }
+    }
+
     def remove(operations: Coll[Coll[Byte]], proof: Coll[Byte]): Option[AvlTree] = {
       if (!tree.isRemoveAllowed) {
         None

diff --git a/sc/shared/src/test/scala/sigma/LanguageSpecificationV5.scala b/sc/shared/src/test/scala/sigma/LanguageSpecificationV5.scala
@@ -3174,11 +3174,6 @@ class LanguageSpecificationV5 extends LanguageSpecificationBase { suite =>
 
   type BatchProver = BatchAVLProver[Digest32, Blake2b256.type]
 
-  def performInsert(avlProver: BatchProver, key: Coll[Byte], value: Coll[Byte]) = {
-    avlProver.performOneOperation(Insert(ADKey @@ key.toArray, ADValue @@ value.toArray))
-    val proof = avlProver.generateProof().toColl
-    proof
-  }
 
   def performUpdate(avlProver: BatchProver, key: Coll[Byte], value: Coll[Byte]) = {
     avlProver.performOneOperation(Update(ADKey @@ key.toArray, ADValue @@ value.toArray))
@@ -3202,144 +3197,6 @@ class LanguageSpecificationV5 extends LanguageSpecificationBase { suite =>
 
   type KV = (Coll[Byte], Coll[Byte])
 
-  property("AvlTree.insert equivalence") {
-    val insert = existingFeature((t: (AvlTree, (Coll[KV], Coll[Byte]))) => t._1.insert(t._2._1, t._2._2),
-      "{ (t: (AvlTree, (Coll[(Coll[Byte], Coll[Byte])], Coll[Byte]))) => t._1.insert(t._2._1, t._2._2) }",
-      FuncValue(
-        Vector(
-          (
-              1,
-              STuple(
-                Vector(
-                  SAvlTree,
-                  STuple(Vector(SCollectionType(STuple(Vector(SByteArray, SByteArray))), SByteArray))
-                )
-              )
-              )
-        ),
-        BlockValue(
-          Vector(
-            ValDef(
-              3,
-              List(),
-              SelectField.typed[Value[STuple]](
-                ValUse(
-                  1,
-                  STuple(
-                    Vector(
-                      SAvlTree,
-                      STuple(Vector(SCollectionType(STuple(Vector(SByteArray, SByteArray))), SByteArray))
-                    )
-                  )
-                ),
-                2.toByte
-              )
-            )
-          ),
-          MethodCall.typed[Value[SOption[SAvlTree.type]]](
-            SelectField.typed[Value[SAvlTree.type]](
-              ValUse(
-                1,
-                STuple(
-                  Vector(
-                    SAvlTree,
-                    STuple(Vector(SCollectionType(STuple(Vector(SByteArray, SByteArray))), SByteArray))
-                  )
-                )
-              ),
-              1.toByte
-            ),
-            SAvlTreeMethods.getMethodByName("insert"),
-            Vector(
-              SelectField.typed[Value[SCollection[STuple]]](
-                ValUse(
-                  3,
-                  STuple(Vector(SCollectionType(STuple(Vector(SByteArray, SByteArray))), SByteArray))
-                ),
-                1.toByte
-              ),
-              SelectField.typed[Value[SCollection[SByte.type]]](
-                ValUse(
-                  3,
-                  STuple(Vector(SCollectionType(STuple(Vector(SByteArray, SByteArray))), SByteArray))
-                ),
-                2.toByte
-              )
-            ),
-            Map()
-          )
-        )
-      ))
-
-    val testTraceBase = Array(
-      FixedCostItem(Apply),
-      FixedCostItem(FuncValue),
-      FixedCostItem(GetVar),
-      FixedCostItem(OptionGet),
-      FixedCostItem(FuncValue.AddToEnvironmentDesc, FixedCost(JitCost(5))),
-      ast.SeqCostItem(CompanionDesc(BlockValue), PerItemCost(JitCost(1), JitCost(1), 10), 1),
-      FixedCostItem(ValUse),
-      FixedCostItem(SelectField),
-      FixedCostItem(FuncValue.AddToEnvironmentDesc, FixedCost(JitCost(5))),
-      FixedCostItem(ValUse),
-      FixedCostItem(SelectField),
-      FixedCostItem(MethodCall),
-      FixedCostItem(ValUse),
-      FixedCostItem(SelectField),
-      FixedCostItem(ValUse),
-      FixedCostItem(SelectField),
-      FixedCostItem(SAvlTreeMethods.isInsertAllowedMethod, FixedCost(JitCost(15)))
-    )
-    val costDetails1 = TracedCost(testTraceBase)
-    val costDetails2 = TracedCost(
-      testTraceBase ++ Array(
-        ast.SeqCostItem(NamedDesc("CreateAvlVerifier"), PerItemCost(JitCost(110), JitCost(20), 64), 70),
-        ast.SeqCostItem(NamedDesc("InsertIntoAvlTree"), PerItemCost(JitCost(40), JitCost(10), 1), 1),
-        FixedCostItem(SAvlTreeMethods.updateDigestMethod, FixedCost(JitCost(40)))
-      )
-    )
-
-    forAll(keyCollGen, bytesCollGen) { (key, value) =>
-      val (tree, avlProver) = createAvlTreeAndProver()
-      val preInsertDigest = avlProver.digest.toColl
-      val insertProof = performInsert(avlProver, key, value)
-      val kvs = Colls.fromItems((key -> value))
-
-      { // positive
-        val preInsertTree = createTree(preInsertDigest, insertAllowed = true)
-        val input = (preInsertTree, (kvs, insertProof))
-        val (res, _) = insert.checkEquality(input).getOrThrow
-        res.isDefined shouldBe true
-        insert.checkExpected(input, Expected(Success(res), 1796, costDetails2, 1796, Seq.fill(4)(2102)))
-      }
-
-      { // negative: readonly tree
-        val readonlyTree = createTree(preInsertDigest)
-        val input = (readonlyTree, (kvs, insertProof))
-        val (res, _) = insert.checkEquality(input).getOrThrow
-        res.isDefined shouldBe false
-        insert.checkExpected(input, Expected(Success(res), 1772, costDetails1, 1772, Seq.fill(4)(2078)))
-      }
-
-      { // negative: invalid key
-        val tree = createTree(preInsertDigest, insertAllowed = true)
-        val invalidKey = key.map(x => (-x).toByte) // any other different from key
-        val invalidKvs = Colls.fromItems((invalidKey -> value)) // NOTE, insertProof is based on `key`
-        val input = (tree, (invalidKvs, insertProof))
-        val (res, _) = insert.checkEquality(input).getOrThrow
-        res.isDefined shouldBe true // TODO v6.0: should it really be true? (looks like a bug) (see https://github.com/ScorexFoundation/sigmastate-interpreter/issues/908)
-        insert.checkExpected(input, Expected(Success(res), 1796, costDetails2, 1796, Seq.fill(4)(2102)))
-      }
-
-      { // negative: invalid proof
-        val tree = createTree(preInsertDigest, insertAllowed = true)
-        val invalidProof = insertProof.map(x => (-x).toByte) // any other different from proof
-        val res = insert.checkEquality((tree, (kvs, invalidProof)))
-        res.isFailure shouldBe true
-      }
-    }
-  }
-
   property("AvlTree.update equivalence") {
     val update = existingFeature((t: (AvlTree, (Coll[KV], Coll[Byte]))) => t._1.update(t._2._1, t._2._2),
       "{ (t: (AvlTree, (Coll[(Coll[Byte], Coll[Byte])], Coll[Byte]))) => t._1.update(t._2._1, t._2._2) }",