Remove ExercisedEvent#contract_creating_event_id. (digital-asset#2262)

This is a breaking change on the ledger api. So far we could rely on the assumption that contractId == eventId. This assumption doesn't hold anymore in a daml-on-x setting, where the eventId is created by the api server, but the absolute contractId is created by the ledger implementation. Instead of going through weird contortions to store the relevant data in the existing database schema, it is more viable in the long term to remove that field and instead provide facilities to lookup transactions by contractId. Contributes to digital-asset#2068.
TuranDev · Jul 29, 2019 · 136f6d1 · 136f6d1
1 parent 0109501
commit 136f6d1
Show file tree

Hide file tree

Showing 25 changed files with 15 additions and 60 deletions.
diff --git a/extractor/src/main/scala/com/digitalasset/extractor/ledger/types/Event.scala b/extractor/src/main/scala/com/digitalasset/extractor/ledger/types/Event.scala
@@ -26,7 +26,6 @@ final case class ExercisedEvent(
     eventId: String,
     contractId: String,
     templateId: Identifier,
-    contractCreatingEventId: String,
     choice: String,
     choiceArgument: LedgerValue,
     actingParties: Set[String],
@@ -84,7 +83,6 @@ object Event {
           apiEvent.eventId,
           apiEvent.contractId,
           templateId,
-          apiEvent.contractCreatingEventId,
           apiEvent.choice,
           choiceArg,
           apiEvent.actingParties.toSet,

diff --git a/extractor/src/main/scala/com/digitalasset/extractor/writers/PostgreSQLWriter.scala b/extractor/src/main/scala/com/digitalasset/extractor/writers/PostgreSQLWriter.scala
@@ -174,7 +174,7 @@ class PostgreSQLWriter(config: ExtractorConfig, target: PostgreSQLTarget, ledger
     }(scala.collection.breakOut)
 
     val exercisedEvents: List[ExercisedEvent] = transaction.events.values.collect {
-      case e @ ExercisedEvent(_, _, _, _, _, _, _, _, _, _) => e
+      case e @ ExercisedEvent(_, _, _, _, _, _, _, _, _) => e
     }(scala.collection.breakOut)
 
     logger.trace(s"Create events: ${com.digitalasset.extractor.pformat(createdEvents)}")

diff --git a/...r/src/main/scala/com/digitalasset/extractor/writers/postgresql/MultiTableDataFormat.scala b/...r/src/main/scala/com/digitalasset/extractor/writers/postgresql/MultiTableDataFormat.scala
@@ -176,7 +176,7 @@ class MultiTableDataFormat(
         if (event.consuming)
           setContractArchived(
             table.withSchema,
-            event.contractCreatingEventId,
+            event.contractId,
             transaction.transactionId,
             event.eventId).update.run.void
         else

diff --git a/extractor/src/main/scala/com/digitalasset/extractor/writers/postgresql/Queries.scala b/extractor/src/main/scala/com/digitalasset/extractor/writers/postgresql/Queries.scala
@@ -123,7 +123,6 @@ object Queries {
           ,contract_id TEXT NOT NULL
           ,package_id TEXT NOT NULL
           ,template TEXT NOT NULL
-          ,contract_creating_event_id TEXT NOT NULL
           ,choice TEXT NOT NULL
           ,choice_argument JSONB NOT NULL
           ,acting_parties JSONB NOT NULL
@@ -143,7 +142,6 @@ object Queries {
           ${event.contractId},
           ${event.templateId.packageId},
           ${event.templateId.name},
-          ${event.contractCreatingEventId},
           ${event.choice},
           ${toJsonString(event.choiceArgument)}::jsonb,
           ${toJsonString(event.actingParties)}::jsonb,
@@ -174,15 +172,15 @@ object Queries {
     """
 
     def setContractArchived(
-        eventId: String,
+        contractId: String,
         transactionId: String,
         archivedByEventId: String): Fragment =
       sql"""
         UPDATE contract
         SET
           archived_by_transaction_id = ${transactionId},
           archived_by_event_id = ${archivedByEventId}
-        WHERE event_id = ${eventId}
+        WHERE contract_id = ${contractId}
       """
 
     def insertContract(event: CreatedEvent, transactionId: String, isRoot: Boolean): Fragment =
@@ -227,13 +225,13 @@ object Queries {
 
     def setContractArchived(
         table: String,
-        eventId: String,
+        contractId: String,
         transactionId: String,
         archivedByEventId: String
     ): Fragment =
       Fragment.const(s"UPDATE ${table} SET ") ++
         fr"_archived_by_transaction_id = ${transactionId}, " ++
-        fr"_archived_by_event_id = ${archivedByEventId} WHERE _event_id = ${eventId}"
+        fr"_archived_by_event_id = ${archivedByEventId} WHERE _contract_id = ${contractId}"
 
     def insertContract(
         table: String,

diff --git a/.../src/main/scala/com/digitalasset/extractor/writers/postgresql/SingleTableDataFormat.scala b/.../src/main/scala/com/digitalasset/extractor/writers/postgresql/SingleTableDataFormat.scala
@@ -50,7 +50,7 @@ class SingleTableDataFormat extends DataFormat[SingleTableState.type] {
       event: ExercisedEvent
   ): Writer.RefreshPackages \/ ConnectionIO[Unit] = {
     val query =
-      setContractArchived(event.contractCreatingEventId, transaction.transactionId, event.eventId)
+      setContractArchived(event.contractId, transaction.transactionId, event.eventId)
 
     query.update.run.void.right
   }

diff --git a/extractor/src/test/lib/scala/com/digitalasset/extractor/services/Types.scala b/extractor/src/test/lib/scala/com/digitalasset/extractor/services/Types.scala
@@ -47,7 +47,6 @@ trait Types {
       contract_id: String,
       package_id: String,
       template: String,
-      contract_creating_event_id: String,
       choice: String,
       choice_argument: Json,
       acting_parties: Json,

diff --git a/language-support/hs/bindings/src/DA/Ledger/Convert.hs b/language-support/hs/bindings/src/DA/Ledger/Convert.hs
@@ -245,7 +245,6 @@ raiseTreeEvent = \case
         eid <- raiseEventId exercisedEventEventId
         cid <- raiseContractId exercisedEventContractId
         tid <- perhaps "exercisedEventTemplateId" exercisedEventTemplateId >>= raiseTemplateId
-        ccEid <- raiseEventId exercisedEventContractCreatingEventId
         choice <- raiseChoice exercisedEventChoice
         choiceArg <- perhaps "exercisedEventChoiceArgument" exercisedEventChoiceArgument >>= raiseValue
         acting <- raiseList raiseParty exercisedEventActingParties

diff --git a/language-support/hs/bindings/src/DA/Ledger/Types.hs b/language-support/hs/bindings/src/DA/Ledger/Types.hs
@@ -149,7 +149,6 @@ data TreeEvent
         eid       :: EventId,
         cid       :: ContractId,
         tid       :: TemplateId,
-        ccEid     :: EventId,
         choice    :: Choice,
         choiceArg :: Value,
         acting    :: [Party],

diff --git a/...ings-rxjava/src/test/scala/com/daml/ledger/rxjava/grpc/helpers/TransactionGenerator.scala b/...ings-rxjava/src/test/scala/com/daml/ledger/rxjava/grpc/helpers/TransactionGenerator.scala
@@ -232,7 +232,6 @@ object TransactionGenerator {
     eventId <- nonEmptyId
     contractId <- nonEmptyId
     (scalaTemplateId, javaTemplateId) <- identifierGen
-    creatingEventId <- nonEmptyId
     choice <- nonEmptyId
     (scalaChoiceArgument, javaChoiceArgument) <- Gen.sized(valueGen)
     actingParties <- Gen.listOf(nonEmptyId)
@@ -247,7 +246,6 @@ object TransactionGenerator {
           eventId,
           contractId,
           Some(scalaTemplateId),
-          creatingEventId,
           choice,
           Some(scalaChoiceArgument),
           actingParties,
@@ -261,7 +259,6 @@ object TransactionGenerator {
         eventId,
         javaTemplateId,
         contractId,
-        creatingEventId,
         choice,
         javaChoiceArgument,
         actingParties.asJava,

diff --git a/...uage-support/java/bindings/src/main/java/com/daml/ledger/javaapi/data/ExercisedEvent.java b/...uage-support/java/bindings/src/main/java/com/daml/ledger/javaapi/data/ExercisedEvent.java
@@ -19,8 +19,6 @@ public class ExercisedEvent implements TreeEvent {
 
     private final String contractId;
 
-    private final String contractCreatingEventId;
-
     private final String choice;
 
     private final Value choiceArgument;
@@ -37,7 +35,6 @@ public ExercisedEvent(@NonNull List<@NonNull String> witnessParties,
                           @NonNull String eventId,
                           @NonNull Identifier templateId,
                           @NonNull String contractId,
-                          @NonNull String contractCreatingEventId,
                           @NonNull String choice,
                           @NonNull Value choiceArgument,
                           @NonNull List<@NonNull String> actingParties,
@@ -48,7 +45,6 @@ public ExercisedEvent(@NonNull List<@NonNull String> witnessParties,
         this.eventId = eventId;
         this.templateId = templateId;
         this.contractId = contractId;
-        this.contractCreatingEventId = contractCreatingEventId;
         this.choice = choice;
         this.choiceArgument = choiceArgument;
         this.actingParties = actingParties;
@@ -81,11 +77,6 @@ public String getContractId() {
         return contractId;
     }
 
-    @NonNull
-    public String getContractCreatingEventId() {
-        return contractCreatingEventId;
-    }
-
     @NonNull
     public String getChoice() {
         return choice;
@@ -124,7 +115,6 @@ public boolean equals(Object o) {
                 Objects.equals(eventId, that.eventId) &&
                 Objects.equals(templateId, that.templateId) &&
                 Objects.equals(contractId, that.contractId) &&
-                Objects.equals(contractCreatingEventId, that.contractCreatingEventId) &&
                 Objects.equals(choice, that.choice) &&
                 Objects.equals(choiceArgument, that.choiceArgument) &&
                 Objects.equals(actingParties, that.actingParties) &&
@@ -134,7 +124,7 @@ public boolean equals(Object o) {
     @Override
     public int hashCode() {
 
-        return Objects.hash(witnessParties, eventId, templateId, contractId, contractCreatingEventId, choice, choiceArgument, actingParties, consuming, exerciseResult);
+        return Objects.hash(witnessParties, eventId, templateId, contractId, choice, choiceArgument, actingParties, consuming, exerciseResult);
     }
 
     @Override
@@ -144,7 +134,6 @@ public String toString() {
                 ", eventId='" + eventId + '\'' +
                 ", templateId=" + templateId +
                 ", contractId='" + contractId + '\'' +
-                ", contractCreatingEventId='" + contractCreatingEventId + '\'' +
                 ", choice='" + choice + '\'' +
                 ", choiceArgument=" + choiceArgument +
                 ", actingParties=" + actingParties +
@@ -162,7 +151,6 @@ public String toString() {
                 .setConsuming(isConsuming())
                 .setContractId(getContractId())
                 .setTemplateId(getTemplateId().toProto())
-                .setContractCreatingEventId(getContractCreatingEventId())
                 .addAllActingParties(getActingParties())
                 .addAllWitnessParties(getWitnessParties())
                 .addAllChildEventIds(getChildEventIds())
@@ -176,7 +164,6 @@ public static ExercisedEvent fromProto(EventOuterClass.ExercisedEvent exercisedE
                 exercisedEvent.getEventId(),
                 Identifier.fromProto(exercisedEvent.getTemplateId()),
                 exercisedEvent.getContractId(),
-                exercisedEvent.getContractCreatingEventId(),
                 exercisedEvent.getChoice(),
                 Value.fromProto(exercisedEvent.getChoiceArgument()),
                 exercisedEvent.getActingPartiesList(),

diff --git a/language-support/java/bindings/src/test/scala/com/daml/ledger/javaapi/data/Generators.scala b/language-support/java/bindings/src/test/scala/com/daml/ledger/javaapi/data/Generators.scala
@@ -232,7 +232,6 @@ object Generators {
       choice <- Arbitrary.arbString.arbitrary
       choiceArgument <- valueGen
       isConsuming <- Arbitrary.arbBool.arbitrary
-      contractCreatingEventId <- Arbitrary.arbString.arbitrary
       witnessParties <- Gen.listOf(Arbitrary.arbString.arbitrary)
       exerciseResult <- valueGen
     } yield
@@ -244,7 +243,6 @@ object Generators {
         .setChoice(choice)
         .setChoiceArgument(choiceArgument)
         .setConsuming(isConsuming)
-        .setContractCreatingEventId(contractCreatingEventId)
         .setEventId(eventId)
         .addAllWitnessParties(witnessParties.asJava)
         .setExerciseResult(exerciseResult)

diff --git a/ledger-api/grpc-definitions/com/digitalasset/ledger/api/v1/event.proto b/ledger-api/grpc-definitions/com/digitalasset/ledger/api/v1/event.proto
@@ -127,10 +127,7 @@ message ExercisedEvent {
   // Required
   Identifier template_id = 3;
 
-  // The ID of the event in which the target contract has been created.
-  // Must be a valid LedgerString (as described in ``value.proto``).
-  // Required
-  string contract_creating_event_id = 4;
+  reserved 4; // removed field
 
   // The choice that's been exercised on the target contract.
   // Must be a valid NameString (as described in ``value.proto``).

diff --git a/...testing-utils/src/main/scala/com/digitalasset/ledger/api/testing/utils/MockMessages.scala b/...testing-utils/src/main/scala/com/digitalasset/ledger/api/testing/utils/MockMessages.scala
@@ -73,7 +73,6 @@ object MockMessages {
     eventIdExercised,
     contractId,
     Some(templateId),
-    eventIdCreated,
     choice,
     None,
     List(party),
@@ -114,7 +113,6 @@ object MockMessages {
     randomId("event-id"),
     randomId("contract-id"),
     Some(Identifier(randomId("package-id"), randomId("moduleName"), randomId("template-id"))),
-    randomId("event-id"),
     randomId("choice-id"),
     None,
     List(randomId("party")),

diff --git a/...in/scala/com/daml/ledger/api/server/damlonx/services/backport/TransactionConversion.scala b/...in/scala/com/daml/ledger/api/server/damlonx/services/backport/TransactionConversion.scala
@@ -121,7 +121,6 @@ trait TransactionConversion {
       // or remove this field here altogether.
       exercise.contractId.coid,
       Some(LfEngineToApi.toApiIdentifier(exercise.templateId)),
-      exercise.contractId.coid,
       exercise.choice,
       Some(
         LfEngineToApi

diff --git a/...ain/scala/com/digitalasset/platform/server/api/services/grpc/GrpcTransactionService.scala b/...ain/scala/com/digitalasset/platform/server/api/services/grpc/GrpcTransactionService.scala
@@ -232,7 +232,6 @@ class GrpcTransactionService(
       eventId.unwrap,
       contractId.unwrap,
       Some(LfEngineToApi.toApiIdentifier(templateId)),
-      contractCreatingEventId.unwrap,
       choice,
       Some(
         LfEngineToApi

diff --git a/ledger/ledger-api-domain/src/main/scala/com/digitalasset/ledger/api/domain.scala b/ledger/ledger-api-domain/src/main/scala/com/digitalasset/ledger/api/domain.scala
@@ -97,7 +97,6 @@ object domain {
         eventId: EventId,
         contractId: ContractId,
         templateId: Ref.Identifier,
-        contractCreatingEventId: EventId,
         choice: Ref.ChoiceName,
         choiceArgument: Value,
         actingParties: immutable.Set[Ref.Party],

diff --git a/...ts/src/test/lib/scala/com/digitalasset/platform/apitesting/CommandTransactionChecks.scala b/...ts/src/test/lib/scala/com/digitalasset/platform/apitesting/CommandTransactionChecks.scala
@@ -654,7 +654,6 @@ abstract class CommandTransactionChecks
           exercisedEvent.choice shouldBe "DummyChoice1"
           exercisedEvent.contractId shouldBe createdEvent.contractId
           exercisedEvent.consuming shouldBe true
-          exercisedEvent.contractCreatingEventId shouldBe createdEvent.eventId
         }
       }
 

diff --git a/...rc/main/scala/com/digitalasset/platform/sandbox/stores/ledger/TransactionConversion.scala b/...rc/main/scala/com/digitalasset/platform/sandbox/stores/ledger/TransactionConversion.scala
@@ -159,12 +159,8 @@ trait TransactionConversion {
   ): domain.Event.ExercisedEvent = {
     domain.Event.ExercisedEvent(
       eventId,
-      // TODO right now we assume throughout the codebase that the event id _is_ the contract id.
-      // this is pretty nasty, we should either not assume that and just look the event id up somewhere,
-      // or remove this field here altogether.
       domain.ContractId(exercise.contractId.coid),
       exercise.templateId,
-      domain.EventId(exercise.contractId.coid),
       exercise.choice,
       exercise.choiceArgument.value,
       exercise.actingParties,

diff --git a/navigator/backend/src/main/scala/com/digitalasset/navigator/data/EventRow.scala b/navigator/backend/src/main/scala/com/digitalasset/navigator/data/EventRow.scala
@@ -24,7 +24,6 @@ final case class EventRow(
     subclassType: String,
     templateId: Option[String],
     recordArgument: Option[String],
-    contractCreateEventId: Option[String],
     choice: Option[String],
     argumentValue: Option[String],
     actingParties: Option[String],
@@ -79,7 +78,6 @@ final case class EventRow(
       case "ChoiceExercised" =>
         (for {
           wp <- Try(witnessParties.parseJson.convertTo[List[ApiTypes.Party]])
-          createId <- Try(contractCreateEventId.get)
           chc <- Try(choice.get)
           argJson <- Try(argumentValue.get)
           tp <- Try(templateId.get)
@@ -101,7 +99,6 @@ final case class EventRow(
             wp,
             ApiTypes.WorkflowId(workflowId),
             ApiTypes.ContractId(contractId),
-            ApiTypes.EventId(createId),
             tid,
             ApiTypes.Choice(chc),
             arg,
@@ -138,7 +135,6 @@ object EventRow {
           None,
           None,
           None,
-          None,
           c.agreementText,
           c.signatories.toJson.compactPrint,
           c.observers.toJson.compactPrint,
@@ -155,7 +151,6 @@ object EventRow {
           "ChoiceExercised",
           Some(e.templateId.asOpaqueString),
           None,
-          Some(e.contractCreateEvent.unwrap),
           Some(e.choice.unwrap),
           Some(e.argument.toJson.compactPrint),
           Some(e.actingParties.toJson.compactPrint),

diff --git a/navigator/backend/src/main/scala/com/digitalasset/navigator/data/Queries.scala b/navigator/backend/src/main/scala/com/digitalasset/navigator/data/Queries.scala
@@ -47,7 +47,6 @@ object Queries {
             subclass_type TEXT NOT NULL,
             template_id TEXT DEFAULT NULL,
             record_argument JSON DEFAULT NULL,
-            contract_create_event_id TEXT DEFAULT NULL,
             choice TEXT DEFAULT NULL,
             argument_value JSON DEFAULT NULL,
             acting_parties JSON DEFAULT NULL,
@@ -128,10 +127,10 @@ object Queries {
       INSERT INTO 
         event 
         (id, transaction_id, workflow_id, parent_id, contract_id, witness_parties, subclass_type, 
-        template_id, record_argument, contract_create_event_id, choice, argument_value, acting_parties, is_consuming, agreement_text, signatories, observers, contract_key)
+        template_id, record_argument, choice, argument_value, acting_parties, is_consuming, agreement_text, signatories, observers, contract_key)
       VALUES 
         (${row.id}, ${row.transactionId}, ${row.workflowId}, ${row.parentId}, ${row.contractId}, ${row.witnessParties}, ${row.subclassType}, 
-        ${row.templateId}, ${row.recordArgument}, ${row.contractCreateEventId}, ${row.choice}, ${row.argumentValue}, ${row.actingParties}, ${row.isConsuming}, ${row.agreementText}, ${row.signatories}, ${row.observers}, ${row.key})
+        ${row.templateId}, ${row.recordArgument}, ${row.choice}, ${row.argumentValue}, ${row.actingParties}, ${row.isConsuming}, ${row.agreementText}, ${row.signatories}, ${row.observers}, ${row.key})
     """
 
   def eventById(id: String): Fragment =

diff --git a/navigator/backend/src/main/scala/com/digitalasset/navigator/model/Model.scala b/navigator/backend/src/main/scala/com/digitalasset/navigator/model/Model.scala
@@ -160,7 +160,6 @@ final case class ChoiceExercised(
     witnessParties: List[ApiTypes.Party],
     workflowId: ApiTypes.WorkflowId,
     contractId: ApiTypes.ContractId,
-    contractCreateEvent: ApiTypes.EventId,
     templateId: DamlLfIdentifier,
     choice: ApiTypes.Choice,
     argument: ApiValue,

diff --git a/...gator/backend/src/main/scala/com/digitalasset/navigator/model/converter/LedgerApiV1.scala b/...gator/backend/src/main/scala/com/digitalasset/navigator/model/converter/LedgerApiV1.scala
@@ -250,7 +250,6 @@ case object LedgerApiV1 {
         witnessParties = witnessParties,
         workflowId = workflowId,
         contractId = ApiTypes.ContractId(event.contractId),
-        contractCreateEvent = ApiTypes.EventId(event.contractCreatingEventId),
         templateId = templateIdentifier,
         choice = ApiTypes.Choice(event.choice),
         argument = modelArgument,

diff --git a/navigator/backend/src/test/scala/com/digitalasset/navigator/backend/data/RowSpec.scala b/navigator/backend/src/test/scala/com/digitalasset/navigator/backend/data/RowSpec.scala
@@ -149,7 +149,6 @@ class RowSpec extends WordSpec with Matchers {
         List(ApiTypes.Party("p01")),
         ApiTypes.WorkflowId("w01"),
         ApiTypes.ContractId("c01"),
-        ApiTypes.EventId("e02"),
         C.complexRecordId,
         ApiTypes.Choice("text"),
         C.simpleTextV,