Preparation for major version 4.0.0 release.

Author: MrMatthewLayton

gradle.properties

@@ -1,5 +1,5 @@
 name=onixlabs-corda-identity-framework
 group=io.onixlabs
-version=4.0.0-rc4
+version=4.0.0-rc5
 onixlabs.development.jarsign.keystore=../lib/onixlabs.development.pkcs12
 onixlabs.development.jarsign.password=5891f47942424d2acbe108691fdb5ba258712fca7e4762be4327241ebf3dbfa3

onixlabs-corda-identity-framework-contract/src/main/kotlin/io/onixlabs/corda/identityframework/contract/Extensions.Attestation.kt

@@ -53,7 +53,7 @@ inline fun <reified T : ContractState, reified U : Attestation<T>> StateAndRef<U
     status: AttestationStatus,
     stateAndRef: StateAndRef<T>,
     metadata: Map<String, String> = emptyMap()
-): U = amendAttestation(status, stateAndRef.toStaticAttestationPointer(), metadata)
+): U = amendAttestation(status, stateAndRef.toStaticAttestationPointer(state.data.pointer.identifier), metadata)
 
 /**
  * Amends an attestation of a [LinearState].
@@ -69,7 +69,7 @@ inline fun <reified T : LinearState, reified U : Attestation<T>> StateAndRef<U>.
     status: AttestationStatus,
     stateAndRef: StateAndRef<T>,
     metadata: Map<String, String> = emptyMap()
-): U = amendAttestation(status, stateAndRef.toLinearAttestationPointer(), metadata)
+): U = amendAttestation(status, stateAndRef.toLinearAttestationPointer(state.data.pointer.identifier), metadata)
 
 /**
  * Accepts an attestation.
@@ -97,7 +97,7 @@ inline fun <T : ContractState, reified U : Attestation<T>> StateAndRef<U>.accept
 inline fun <T : ContractState, reified U : Attestation<T>> StateAndRef<U>.acceptStaticAttestation(
     stateAndRef: StateAndRef<T>,
     metadata: Map<String, String> = emptyMap()
-): U = amendAttestation(AttestationStatus.ACCEPTED, stateAndRef.toStaticAttestationPointer(), metadata)
+): U = amendAttestation(AttestationStatus.ACCEPTED, stateAndRef.toStaticAttestationPointer(state.data.pointer.identifier), metadata)
 
 /**
  * Accepts an attestation of a [LinearState].
@@ -111,7 +111,7 @@ inline fun <T : ContractState, reified U : Attestation<T>> StateAndRef<U>.accept
 inline fun <T : LinearState, reified U : Attestation<T>> StateAndRef<U>.acceptLinearAttestation(
     stateAndRef: StateAndRef<T>,
     metadata: Map<String, String> = emptyMap()
-): U = amendAttestation(AttestationStatus.ACCEPTED, stateAndRef.toLinearAttestationPointer(), metadata)
+): U = amendAttestation(AttestationStatus.ACCEPTED, stateAndRef.toLinearAttestationPointer(state.data.pointer.identifier), metadata)
 
 /**
  * Rejects an attestation.
@@ -139,7 +139,7 @@ inline fun <T : ContractState, reified U : Attestation<T>> StateAndRef<U>.reject
 inline fun <T : ContractState, reified U : Attestation<T>> StateAndRef<U>.rejectStaticAttestation(
     stateAndRef: StateAndRef<T>,
     metadata: Map<String, String> = emptyMap()
-): U = amendAttestation(AttestationStatus.REJECTED, stateAndRef.toStaticAttestationPointer(), metadata)
+): U = amendAttestation(AttestationStatus.REJECTED, stateAndRef.toStaticAttestationPointer(state.data.pointer.identifier), metadata)
 
 /**
  * Rejects an attestation of a [LinearState].
@@ -153,4 +153,4 @@ inline fun <T : ContractState, reified U : Attestation<T>> StateAndRef<U>.reject
 inline fun <T : LinearState, reified U : Attestation<T>> StateAndRef<U>.rejectLinearAttestation(
     stateAndRef: StateAndRef<T>,
     metadata: Map<String, String> = emptyMap()
-): U = amendAttestation(AttestationStatus.REJECTED, stateAndRef.toLinearAttestationPointer(), metadata)
+): U = amendAttestation(AttestationStatus.REJECTED, stateAndRef.toLinearAttestationPointer(state.data.pointer.identifier), metadata)

onixlabs-corda-identity-framework-contract/src/main/kotlin/io/onixlabs/corda/identityframework/contract/Extensions.StateAndRef.kt

@@ -30,20 +30,22 @@ import net.corda.core.identity.AbstractParty
  * Creates a static attestation pointer from a [StateAndRef].
  *
  * @param T The underlying [ContractState] type.
+ * @param identifier Provides an additional, external identifier which can be used to track states across state transitions.
  * @return Returns a static attestation pointer for the specified [StateAndRef].
  */
-fun <T : ContractState> StateAndRef<T>.toStaticAttestationPointer(): StaticAttestationPointer<T> {
-    return StaticAttestationPointer(this)
+fun <T : ContractState> StateAndRef<T>.toStaticAttestationPointer(identifier: String? = null): StaticAttestationPointer<T> {
+    return StaticAttestationPointer(this, identifier)
 }
 
 /**
  * Creates a linear attestation pointer from a [StateAndRef].
  *
  * @param T The underlying [LinearState] type.
+ * @param identifier Provides an additional, external identifier which can be used to track states across state transitions.
  * @return Returns a linear attestation pointer for the specified [StateAndRef].
  */
-fun <T : LinearState> StateAndRef<T>.toLinearAttestationPointer(): LinearAttestationPointer<T> {
-    return LinearAttestationPointer(this)
+fun <T : LinearState> StateAndRef<T>.toLinearAttestationPointer(identifier: String? = state.data.linearId.toString()): LinearAttestationPointer<T> {
+    return LinearAttestationPointer(this, identifier)
 }
 
 /**
@@ -54,17 +56,19 @@ fun <T : LinearState> StateAndRef<T>.toLinearAttestationPointer(): LinearAttesta
  * @param status The status of the attestation.
  * @param metadata Additional information about the attestation.
  * @param linearId The unique identifier of the attestation.
+ * @param identifier Provides an additional, external identifier which can be used to track states across state transitions.
  * @return Returns an attestation for the specified [StateAndRef].
  */
 fun <T : ContractState> StateAndRef<T>.createStaticAttestation(
     attestor: AbstractParty,
     status: AttestationStatus,
     metadata: Map<String, String> = emptyMap(),
-    linearId: UniqueIdentifier = UniqueIdentifier()
+    linearId: UniqueIdentifier = UniqueIdentifier(),
+    identifier: String? = null
 ): Attestation<T> = Attestation(
     attestor,
     state.data.participants.toSet(),
-    toStaticAttestationPointer(),
+    toStaticAttestationPointer(identifier),
     status,
     metadata,
     linearId,
@@ -78,13 +82,15 @@ fun <T : ContractState> StateAndRef<T>.createStaticAttestation(
  * @param attestor The attestor of the witnessed state.
  * @param metadata Additional information about the attestation.
  * @param linearId The unique identifier of the attestation.
+ * @param identifier Provides an additional, external identifier which can be used to track states across state transitions.
  * @return Returns an accepted attestation for the specified [StateAndRef].
  */
 fun <T : ContractState> StateAndRef<T>.createAcceptedStaticAttestation(
     attestor: AbstractParty,
     metadata: Map<String, String> = emptyMap(),
-    linearId: UniqueIdentifier = UniqueIdentifier()
-): Attestation<T> = createStaticAttestation(attestor, AttestationStatus.ACCEPTED, metadata, linearId)
+    linearId: UniqueIdentifier = UniqueIdentifier(),
+    identifier: String? = null
+): Attestation<T> = createStaticAttestation(attestor, AttestationStatus.ACCEPTED, metadata, linearId, identifier)
 
 /**
  * Creates a rejected attestation from the specified [StateAndRef].
@@ -93,13 +99,15 @@ fun <T : ContractState> StateAndRef<T>.createAcceptedStaticAttestation(
  * @param attestor The attestor of the witnessed state.
  * @param metadata Additional information about the attestation.
  * @param linearId The unique identifier of the attestation.
+ * @param identifier Provides an additional, external identifier which can be used to track states across state transitions.
  * @return Returns an rejected attestation for the specified [StateAndRef].
  */
 fun <T : ContractState> StateAndRef<T>.createRejectedStaticAttestation(
     attestor: AbstractParty,
     metadata: Map<String, String> = emptyMap(),
-    linearId: UniqueIdentifier = UniqueIdentifier()
-): Attestation<T> = createStaticAttestation(attestor, AttestationStatus.REJECTED, metadata, linearId)
+    linearId: UniqueIdentifier = UniqueIdentifier(),
+    identifier: String? = null
+): Attestation<T> = createStaticAttestation(attestor, AttestationStatus.REJECTED, metadata, linearId, identifier)
 
 /**
  * Creates an attestation from the specified [StateAndRef].
@@ -109,17 +117,19 @@ fun <T : ContractState> StateAndRef<T>.createRejectedStaticAttestation(
  * @param status The status of the attestation.
  * @param metadata Additional information about the attestation.
  * @param linearId The unique identifier of the attestation.
+ * @param identifier Provides an additional, external identifier which can be used to track states across state transitions.
  * @return Returns an attestation for the specified [StateAndRef].
  */
 fun <T : LinearState> StateAndRef<T>.createLinearAttestation(
     attestor: AbstractParty,
     status: AttestationStatus,
     metadata: Map<String, String> = emptyMap(),
-    linearId: UniqueIdentifier = UniqueIdentifier()
+    linearId: UniqueIdentifier = UniqueIdentifier(),
+    identifier: String? = state.data.linearId.toString()
 ): Attestation<T> = Attestation(
     attestor,
     state.data.participants.toSet(),
-    toLinearAttestationPointer(),
+    toLinearAttestationPointer(identifier),
     status,
     metadata,
     linearId,
@@ -133,13 +143,15 @@ fun <T : LinearState> StateAndRef<T>.createLinearAttestation(
  * @param attestor The attestor of the witnessed state.
  * @param metadata Additional information about the attestation.
  * @param linearId The unique identifier of the attestation.
+ * @param identifier Provides an additional, external identifier which can be used to track states across state transitions.
  * @return Returns an accepted attestation for the specified [StateAndRef].
  */
 fun <T : LinearState> StateAndRef<T>.createAcceptedLinearAttestation(
     attestor: AbstractParty,
     metadata: Map<String, String> = emptyMap(),
-    linearId: UniqueIdentifier = UniqueIdentifier()
-): Attestation<T> = createLinearAttestation(attestor, AttestationStatus.ACCEPTED, metadata, linearId)
+    linearId: UniqueIdentifier = UniqueIdentifier(),
+    identifier: String? = state.data.linearId.toString()
+): Attestation<T> = createLinearAttestation(attestor, AttestationStatus.ACCEPTED, metadata, linearId, identifier)
 
 /**
  * Creates a rejected attestation from the specified [StateAndRef].
@@ -148,10 +160,12 @@ fun <T : LinearState> StateAndRef<T>.createAcceptedLinearAttestation(
  * @param attestor The attestor of the witnessed state.
  * @param metadata Additional information about the attestation.
  * @param linearId The unique identifier of the attestation.
+ * @param identifier Provides an additional, external identifier which can be used to track states across state transitions.
  * @return Returns an rejected attestation for the specified [StateAndRef].
  */
 fun <T : LinearState> StateAndRef<T>.createRejectedLinearAttestation(
     attestor: AbstractParty,
     metadata: Map<String, String> = emptyMap(),
-    linearId: UniqueIdentifier = UniqueIdentifier()
-): Attestation<T> = createLinearAttestation(attestor, AttestationStatus.REJECTED, metadata, linearId)
+    linearId: UniqueIdentifier = UniqueIdentifier(),
+    identifier: String? = state.data.linearId.toString()
+): Attestation<T> = createLinearAttestation(attestor, AttestationStatus.REJECTED, metadata, linearId, identifier)

onixlabs-corda-identity-framework-contract/src/main/kotlin/io/onixlabs/corda/identityframework/contract/attestations/AttestationContract.kt

@@ -18,7 +18,10 @@ package io.onixlabs.corda.identityframework.contract.attestations
 
 import io.onixlabs.corda.core.contract.ContractID
 import io.onixlabs.corda.core.contract.isPointingTo
-import net.corda.core.contracts.*
+import net.corda.core.contracts.CommandData
+import net.corda.core.contracts.Contract
+import net.corda.core.contracts.requireSingleCommand
+import net.corda.core.contracts.requireThat
 import net.corda.core.transactions.LedgerTransaction
 import java.security.PublicKey
 
@@ -75,7 +78,7 @@ open class AttestationContract : Contract {
             "On attestation amending, only one attestation state must be created."
 
         internal const val CONTRACT_RULE_CHANGES =
-            "On attestation amending, the attestor, linear ID, pointer class and pointer linear ID must not change."
+            "On attestation amending, the attestor, linear ID, pointer class and pointer identifier must not change."
 
         internal const val CONTRACT_RULE_STATE_REF =
             "On attestation amending, the created attestation state must point to the consumed attestation state."

onixlabs-corda-identity-framework-contract/src/main/kotlin/io/onixlabs/corda/identityframework/contract/attestations/AttestationPointer.kt

@@ -37,6 +37,7 @@ import java.util.*
  * @param T The underlying [ContractState] type.
  * @property stateType The [Class] of the witnessed state being attested.
  * @property statePointer The pointer to the witnessed state being attested.
+ * @property identifier Provides an additional, external identifier which can be used to track states across state transitions.
  * @property hash The hash of the attestation pointer.
  *
  * Note that attestation pointer hashes should be unique for static attestation pointers since they point to the
@@ -47,9 +48,10 @@ import java.util.*
 sealed class AttestationPointer<T : ContractState> : SingularResolvable<T>, Hashable {
     abstract val stateType: Class<T>
     abstract val statePointer: Any
+    abstract val identifier: String?
 
     final override val hash: SecureHash
-        get() = SecureHash.sha256("$stateType$statePointer")
+        get() = SecureHash.sha256("$stateType$statePointer$identifier")
 
     /**
      * Determines whether the specified object is equal to the current object.
@@ -121,14 +123,20 @@ sealed class AttestationPointer<T : ContractState> : SingularResolvable<T>, Hash
  * @param T The underlying [LinearState] type.
  * @property stateType The [Class] of the witnessed state being attested.
  * @property statePointer The pointer to the witnessed state being attested.
+ * @property identifier Provides an additional, external identifier which can be used to track states across state transitions.
  * @property hash The hash of the attestation pointer.
  */
 class LinearAttestationPointer<T : LinearState> internal constructor(
     override val stateType: Class<T>,
-    override val statePointer: UniqueIdentifier
+    override val statePointer: UniqueIdentifier,
+    override val identifier: String?
 ) : AttestationPointer<T>() {
 
-    constructor(stateAndRef: StateAndRef<T>) : this(stateAndRef.state.data.javaClass, stateAndRef.state.data.linearId)
+    constructor(stateAndRef: StateAndRef<T>, identifier: String?) : this(
+        stateType = stateAndRef.state.data.javaClass,
+        statePointer = stateAndRef.state.data.linearId,
+        identifier = identifier
+    )
 
     private val criteria: QueryCriteria = vaultQuery(stateType) {
         stateStatus(Vault.StateStatus.UNCONSUMED)
@@ -193,6 +201,7 @@ class LinearAttestationPointer<T : LinearState> internal constructor(
         return other is LinearAttestationPointer<*>
                 && other.stateType == stateType
                 && other.statePointer == statePointer
+                && other.identifier == identifier
     }
 }
 
@@ -209,14 +218,20 @@ class LinearAttestationPointer<T : LinearState> internal constructor(
  * @param T The underlying [LinearState] type.
  * @property stateType The [Class] of the witnessed state being attested.
  * @property statePointer The pointer to the witnessed state being attested.
+ * @property identifier Provides an additional, external identifier which can be used to track states across state transitions.
  * @property hash The hash of the attestation pointer.
  */
 class StaticAttestationPointer<T : ContractState> internal constructor(
     override val stateType: Class<T>,
-    override val statePointer: StateRef
+    override val statePointer: StateRef,
+    override val identifier: String?
 ) : AttestationPointer<T>() {
 
-    constructor(stateAndRef: StateAndRef<T>) : this(stateAndRef.state.data.javaClass, stateAndRef.ref)
+    constructor(stateAndRef: StateAndRef<T>, identifier: String?) : this(
+        stateType = stateAndRef.state.data.javaClass,
+        statePointer = stateAndRef.ref,
+        identifier = identifier
+    )
 
     private val criteria: QueryCriteria = vaultQuery(stateType) {
         stateStatus(Vault.StateStatus.ALL)
@@ -280,5 +295,6 @@ class StaticAttestationPointer<T : ContractState> internal constructor(
     override fun immutableEquals(other: AttestationPointer<T>): Boolean {
         return other is StaticAttestationPointer<*>
                 && other.stateType == stateType
+                && other.identifier == identifier
     }
 }

onixlabs-corda-identity-framework-contract/src/main/kotlin/io/onixlabs/corda/identityframework/contract/attestations/AttestationSchema.kt

@@ -54,6 +54,9 @@ object AttestationSchema {
         @Column(name = "pointer_state_type", nullable = false)
         val pointerStateType: String = "",
 
+        @Column(name = "pointer_identifier", nullable = true)
+        val pointerIdentifier: String? = null,
+
         @Column(name = "pointer_hash", nullable = false)
         val pointerHash: String = "",
 
@@ -78,6 +81,7 @@ object AttestationSchema {
             attestorAccountExternalId = attestation.attestor.accountLinearId?.externalId,
             pointer = attestation.pointer.statePointer.toString(),
             pointerStateType = attestation.pointer.stateType.canonicalName,
+            pointerIdentifier = attestation.pointer.identifier,
             pointerHash = attestation.pointer.hash.toString(),
             status = attestation.status,
             previousStateRef = attestation.previousStateRef?.toString(),

onixlabs-corda-identity-framework-contract/src/main/resources/migration/attestation-schema.changelog-master.xml

@@ -4,4 +4,5 @@
                    xsi:schemaLocation="http://www.liquibase.org/xml/ns/dbchangelog http://www.liquibase.org/xml/ns/dbchangelog/dbchangelog-3.5.xsd">
     <include file="migration/attestation-schema.changelog-v1.xml"/>
     <include file="migration/attestation-schema.changelog-v2.xml"/>
+    <include file="migration/attestation-schema.changelog-v3.xml"/>
 </databaseChangeLog>

onixlabs-corda-identity-framework-contract/src/main/resources/migration/attestation-schema.changelog-v3.xml

@@ -0,0 +1,10 @@
+<?xml version="1.1" encoding="UTF-8" standalone="no"?>
+<databaseChangeLog xmlns="http://www.liquibase.org/xml/ns/dbchangelog"
+                   xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+                   xsi:schemaLocation="http://www.liquibase.org/xml/ns/dbchangelog http://www.liquibase.org/xml/ns/dbchangelog/dbchangelog-3.5.xsd">
+    <changeSet author="ONIXLabs" id="update-v3-onixlabs_attestation_states">
+        <addColumn tableName="onixlabs_attestation_states">
+            <column name="pointer_identifier" type="nvarchar(1024)"/>
+        </addColumn>
+    </changeSet>
+</databaseChangeLog>

onixlabs-corda-identity-framework-contract/src/test/kotlin/io/onixlabs/corda/identityframework/contract/ContractTest.kt

@@ -72,7 +72,8 @@ abstract class ContractTest {
 
     fun <T : LinearState> StateAndRef<Attestation<T>>.withInvalidPointer(): Attestation<T> {
         return with(state.data) {
-            val invalidPointer = LinearAttestationPointer(pointer.stateType, UniqueIdentifier())
+            val invalidLinearId = UniqueIdentifier()
+            val invalidPointer = LinearAttestationPointer(pointer.stateType, invalidLinearId, invalidLinearId.toString())
             Attestation(attestor, attestees, invalidPointer, status, metadata, linearId, null)
         }
     }

onixlabs-corda-identity-framework-contract/src/test/kotlin/io/onixlabs/corda/identityframework/contract/attestations/AttestationContractAmendCommandTests.kt

@@ -72,7 +72,7 @@ class AttestationContractAmendCommandTests : ContractTest() {
     }
 
     @Test
-    fun `On attestation amending, the attestor, linear ID, pointer class and pointer linear ID must not change (wrong attestor)`() {
+    fun `On attestation amending, the attestor, linear ID, pointer class and pointer identifier must not change (wrong attestor)`() {
         services.ledger {
             transaction {
                 val issuedClaim1 = issue(CLAIM_1)
@@ -87,7 +87,7 @@ class AttestationContractAmendCommandTests : ContractTest() {
     }
 
     @Test
-    fun `On attestation amending, the attestor, linear ID, pointer class and pointer linear ID must not change (wrong pointer)`() {
+    fun `On attestation amending, the attestor, linear ID, pointer class and pointer identifier must not change (wrong pointer)`() {
         services.ledger {
             transaction {
                 val issuedClaim1 = issue(CLAIM_1)