CORE-14023 Find ledger transaction and resolve states (#1193)

Changes to support retrieving a ledger transaction in one step, including resolving the input and reference states of the transaction and retrieving the transaction's signatures.

data/avro-schema/src/main/resources/avro/net/corda/data/ledger/persistence/FindSignedLedgerTransaction.avsc

@@ -0,0 +1,18 @@
+{
+ "type": "record",
+ "name": "FindSignedLedgerTransaction",
+ "doc": "Retrieve the specified ledger transaction, specified by id. One of several types of ledger persistence request {@link LedgerPersistenceRequest}",
+ "namespace": "net.corda.data.ledger.persistence",
+ "fields": [
+ {
+ "name": "id",
+ "type": "string",
+ "doc": "The transaction ID, derived from the root hash of its Merkle tree"
+ },
+ {
+ "name": "transactionStatus",
+ "type": "string",
+ "doc": "The status of the transaction"
+ }
+ ]
+}

data/avro-schema/src/main/resources/avro/net/corda/data/ledger/persistence/LedgerPersistenceRequest.avsc

@@ -38,7 +38,8 @@
  "net.corda.data.ledger.persistence.UpdateTransactionStatus",
  "net.corda.data.persistence.FindWithNamedQuery",
  "net.corda.data.ledger.persistence.FindSignedGroupParameters",
- "net.corda.data.ledger.persistence.PersistSignedGroupParametersIfDoNotExist"
+ "net.corda.data.ledger.persistence.PersistSignedGroupParametersIfDoNotExist",
+ "net.corda.data.ledger.persistence.FindSignedLedgerTransaction"
  ]
  },
  {

data/avro-schema/src/test/kotlin/net/corda/data/ledger/persistence/LedgerPersistenceRequestSchemaCompatibilityTest.kt

@@ -0,0 +1,98 @@
+package net.corda.data.ledger.persistence
+
+import net.corda.data.flow.event.external.ExternalEventContext
+import net.corda.data.identity.HoldingIdentity
+import net.corda.data.persistence.FindWithNamedQuery
+import org.apache.avro.Schema
+import org.apache.avro.SchemaCompatibility
+import org.junit.jupiter.api.Assertions.assertEquals
+import org.junit.jupiter.api.Test
+
+@Suppress("MaxLineLength")
+class LedgerPersistenceRequestSchemaCompatibilityTest {
+
+ @Test
+ fun `LedgerPersistenceRequest schema changes between Corda 5_0 and 5_1 are compatible`() {
+ val oldSchemaJson = """
+ {
+ "type": "record",
+ "name": "LedgerPersistenceRequest",
+ "doc": "Make a persistence request on a ledger. The action is determined by the type of the {@link LedgerPersistenceRequest#request} payload. See also: {@link EntityResponse}, {@link PersistTransaction}",
+ "namespace": "net.corda.data.ledger.persistence",
+ "fields": [
+ {
+ "name": "timestamp",
+ "type": {
+ "type": "long",
+ "logicalType": "timestamp-millis"
+ },
+ "doc": "Time ({@link java.time.Instant}) in milliseconds when the record was created."
+ },
+ {
+ "name": "holdingIdentity",
+ "type": "net.corda.data.identity.HoldingIdentity",
+ "doc": "The holding identity of the user making the DB request."
+ },
+ {
+ "name": "ledgerType",
+ "type": {
+ "name": "LedgerTypes",
+ "type": "enum",
+ "symbols": ["UTXO","CONSENSUAL"]
+ },
+ "doc": "The type of ledger the request is for."
+ },
+ {
+ "name": "request",
+ "doc": "The 'request' that we wish to make to the ledger persistence API.",
+ "type": [
+ "net.corda.data.ledger.persistence.PersistTransaction",
+ "net.corda.data.ledger.persistence.PersistTransactionIfDoesNotExist",
+ "net.corda.data.ledger.persistence.FindTransaction",
+ "net.corda.data.ledger.persistence.FindUnconsumedStatesByType",
+ "net.corda.data.ledger.persistence.ResolveStateRefs",
+ "net.corda.data.ledger.persistence.UpdateTransactionStatus",
+ "net.corda.data.persistence.FindWithNamedQuery",
+ "net.corda.data.ledger.persistence.FindSignedGroupParameters",
+ "net.corda.data.ledger.persistence.PersistSignedGroupParametersIfDoNotExist"
+ ]
+ },
+ {
+ "name": "flowExternalEventContext",
+ "type": "net.corda.data.flow.event.external.ExternalEventContext",
+ "doc": "The context of the external event that this request was sent from."
+ }
+ ]
+ }
+ """.trimIndent()
+
+ val oldSchema = Schema.Parser()
+ .addTypes(
+ mapOf(
+ HoldingIdentity::class.java.name to HoldingIdentity.`SCHEMA$`,
+ PersistTransaction::class.java.name to PersistTransaction.`SCHEMA$`,
+ PersistTransactionIfDoesNotExist::class.java.name to PersistTransactionIfDoesNotExist.`SCHEMA$`,
+ FindTransaction::class.java.name to FindTransaction.`SCHEMA$`,
+ FindUnconsumedStatesByType::class.java.name to FindUnconsumedStatesByType.`SCHEMA$`,
+ ResolveStateRefs::class.java.name to ResolveStateRefs.`SCHEMA$`,
+ UpdateTransactionStatus::class.java.name to UpdateTransactionStatus.`SCHEMA$`,
+ FindWithNamedQuery::class.java.name to FindWithNamedQuery.`SCHEMA$`,
+ FindSignedGroupParameters::class.java.name to FindSignedGroupParameters.`SCHEMA$`,
+ PersistSignedGroupParametersIfDoNotExist::class.java.name to PersistSignedGroupParametersIfDoNotExist.`SCHEMA$`,
+ FindSignedLedgerTransaction::class.java.name to FindSignedLedgerTransaction.`SCHEMA$`,
+ ExternalEventContext::class.java.name to ExternalEventContext.`SCHEMA$`,
+ )
+ )
+ .parse(oldSchemaJson)
+
+ val newSchema = LedgerPersistenceRequest.`SCHEMA$`
+
+ val compatibility = SchemaCompatibility.checkReaderWriterCompatibility(newSchema, oldSchema)
+
+ assertEquals(
+ compatibility.type,
+ SchemaCompatibility.SchemaCompatibilityType.COMPATIBLE,
+ "Failed due to incompatible change. ${compatibility.description}"
+ )
+ }
+}

gradle.properties

@@ -9,7 +9,7 @@ cordaProductVersion = 5.1.0
 # NOTE: update this each time this module contains a breaking change
 ## NOTE: currently this is a top level revision, so all API versions will line up, but this could be moved to
 ## a per module property in which case module versions can change independently.
-cordaApiRevision = 11
+cordaApiRevision = 12
 
 # Main
 kotlinVersion = 1.8.21