ensure that signatories and observers are disjoint in ledger-api Crea…

…tedEvents (#10123) * document that signatories shouldn't appear in observers in ledger-api CHANGELOG_BEGIN CHANGELOG_END * add disjoint signatories/observers checks to ACS and transaction ledger-api tests * scala 2.12 compatibility * "never" replaces "should not" Co-authored-by: Moritz Kiefer <[email protected]> Co-authored-by: Moritz Kiefer <[email protected]>
digital-asset · Jun 28, 2021 · f5e5062 · f5e5062
1 parent ffc88d5
commit f5e5062
Show file tree

Hide file tree

Showing 3 changed files with 44 additions and 0 deletions.
diff --git a/ledger-api/grpc-definitions/com/daml/ledger/api/v1/event.proto b/ledger-api/grpc-definitions/com/daml/ledger/api/v1/event.proto
@@ -71,6 +71,7 @@ message CreatedEvent {
   repeated string signatories = 8;
 
   // The observers for this contract as specified explicitly by the template or implicitly as choice controllers.
+  // This field never contains parties that are signatories.
   // Required
   repeated string observers = 9;
 

diff --git a/...st-tool/src/main/scala/com/daml/ledger/api/testtool/suites/ActiveContractsServiceIT.scala b/...st-tool/src/main/scala/com/daml/ledger/api/testtool/suites/ActiveContractsServiceIT.scala
@@ -19,11 +19,13 @@ import com.daml.ledger.test.model.Test.{
   Dummy,
   DummyFactory,
   DummyWithParam,
+  WithObservers,
   Witnesses => TestWitnesses,
 }
 import io.grpc.Status
 import scalaz.syntax.tag._
 
+import scala.collection.immutable.Seq
 import scala.concurrent.ExecutionContext
 
 class ActiveContractsServiceIT extends LedgerTestSuite {
@@ -377,6 +379,21 @@ class ActiveContractsServiceIT extends LedgerTestSuite {
     }
   })
 
+  test(
+    "ACSnoSignatoryObservers",
+    "The ActiveContractService should not return overlapping signatories and observers",
+    allocate(TwoParties),
+  )(implicit ec => { case Participants(Participant(ledger, alice, bob)) =>
+    for {
+      _ <- ledger.create(alice, WithObservers(alice, Seq(alice, bob)))
+      contracts <- ledger.activeContracts(alice)
+      Seq(ce) = contracts
+    } yield assert(
+      ce.observers == Seq(bob),
+      s"Expected observers to only contain $bob, but received ${ce.observers}",
+    )
+  })
+
   private def createDummyContracts(party: Party, ledger: ParticipantTestContext)(implicit
       ec: ExecutionContext
   ) = {

diff --git a/...i-test-tool/src/main/scala/com/daml/ledger/api/testtool/suites/TransactionServiceIT.scala b/...i-test-tool/src/main/scala/com/daml/ledger/api/testtool/suites/TransactionServiceIT.scala
@@ -38,6 +38,7 @@ import io.grpc.Status
 import scalaz.Tag
 
 import scala.collection.compat._
+import scala.collection.immutable.Seq
 import scala.collection.mutable
 import scala.concurrent.Future
 
@@ -1083,6 +1084,31 @@ class TransactionServiceIT extends LedgerTestSuite {
     }
   })
 
+  test(
+    "TXnoSignatoryObservers",
+    "transactions' created events should not return overlapping signatories and observers",
+    allocate(TwoParties),
+  )(implicit ec => { case Participants(Participant(ledger, alice, bob)) =>
+    for {
+      _ <- ledger.create(alice, WithObservers(alice, Seq(alice, bob)))
+      flat <- ledger.flatTransactions(alice)
+      Seq(flatTx) = flat
+      Seq(flatWo) = createdEvents(flatTx)
+      tree <- ledger.transactionTrees(alice)
+      Seq(treeTx) = tree
+      Seq(treeWo) = createdEvents(treeTx)
+    } yield {
+      assert(
+        flatWo.observers == Seq(bob),
+        s"Expected observers to only contain $bob, but received ${flatWo.observers}",
+      )
+      assert(
+        treeWo.observers == Seq(bob),
+        s"Expected observers to only contain $bob, but received ${treeWo.observers}",
+      )
+    }
+  })
+
   test(
     "TXFlatTransactionsWrongLedgerId",
     "The getTransactions endpoint should reject calls with the wrong ledger identifier",